ruby-debug-base 0.10.0-mswin32 → 0.10.4-mswin32

data/CHANGES

@@ -1,4 +1,131 @@
+0.10.4
+10/27/10
+
+ - Various bug fixes: 
+   * reload command. 
+   * plain 'info' command 
+   * improve list and list - (backwards) handling when hitting end of file
+ - Add ability to specify port to debug on
+ - Allow breakpoints at class methods
+ - "quit!" is same as "quit unconditionally"
+ - irb improvements: Access to non-executing rdebug commands inside irb via 
+   "dbgr" method
+ - Go over documentation including that created by rdoc.
+ - For emacs package: add README, INSTALL, AUTHORS.
+
+0.10.3
+11/17/08
+
+ - a backtrace now warns when it thinks the callstack is truncated which it
+   gets by comparing with caller()
+ - fix setting $0.
+ - fix bug in showing variables in post-mortem
+ - Document how Debugger.start with a block is intended to be used.
+ - Move Kernel#debugger from ruby-debug-base into ruby-debug
+ - Get regression tests working again
+ - Warn and add a "confirmation" when setting a breakpoint on a
+   file that is not loaded.
+
+0.10.2
+ - debugger(steps=0) breaks inside of debugger rather than wait for a line event.
+ - trace var varname (stop|nostop) added which issues trace_var.
+ - start method is now properly defined in Debugger module
+ - fixed 'finish' command
+ - rdebug script now works with Ruby 1.8.7
+
+0.10.1
+4/10/08 - in honor of the 30th Birthday of Kate Schwarz
+
+- bin/rdebug
+
+ * "rdebug --post-mortem" now really catches uncaught exceptions and
+   brings you to post-mortem handling. "info program" shows the exception.
+
+ * rdebug now searches using ENV['PATH'] for a Ruby program to debug
+   if the program name is not found and doesn't have any path
+   characters in it.
+
+ * Use ~/.rdboptrc (rdbopt.ini on MS Windows) to change default options.
+
+ * --emacs is now --emacs-basic while --emacs 3 now implies emacs-basic
+   ---annotate=3 --post-mortem --no-control --no-start --no-quit
+
+- rdebug (CLI)
+
+ *  "info" command additions and changes:
+  o fix bug in "info variables" when string had embedded %s'
+  o "info program" now shows uncaught exception information
+  o "info files" show what Ruby files are loaded
+  o "info file <f>" specific file information of <f> (e.g. time, # of lines, SHA1)
+  o "info catch" - Exceptions that can be caught in the current stack frame.
+  o "info "variables" shows "self" and class variables
+  o "info threads verbose" shows stack trace of all threads
+  o "info thread <t> verbose" shows stack trace of thread <t>.
+
+ * "frame" command now accepts an optional thread number argument
+
+ * Long information added to commands with subcommands: show, set,
+   info, enable, and disable. For example "help info <xxx>" will give
+   more detailed information about the "info <xxx>" command.
+
+ * columnize now pulled in from a separate package.
+
+ * add "var cl[ass]" command. Note "var const" can no longer be
+   abbreviated "var c"; use "var co" (or const or constant).
+
+ * add "condition" command. Allow removal of condition.
+
+ * $0 == __FILE__ when running rdebug should work -- most of the
+   time. See comments in code for a better solution.
+
+ * rdebug command history can be displayed with "show commands". Fix a bug
+   in history saving.
+
+ * INCOMPATIBLE CHANGE: "finish" works like gdb - stop just before the most
+   recent method finishes. Will now accept a number which stops that many
+   frames completed. (Note that return line numbers will be funny, the
+   first line of the method until Ruby 1.8.7.)
+
+ * fix bug in 'list' command when wrapping off the end.
+
+- Emacs interaction drastically reworked, expanded, and improved.
+
+- rdebug base
+ * allow catching multiple exceptions. 
+   INCOMPATIBLE CHANGE: variable "Debugger.catchpoint", a String, was turned
+   into "Debugger.catchpoints", a Hash. Method "Debugger.catchpoint=" no
+   longer exists. Debugger.set_catchpoint was turned into 
+   Debugger.add_catchpoint
+
+ * Add Debugger.last_exception which is set in post-mortem.
+
+ * remove Debugger.stop() when an exception is raised that would terminate the 
+   debugged program. This may allow catchpoints to work and allow tracing user 
+   code which handles "Exit" exceptions
+
+ * split off breakpoint code in ruby_debug.c.
+
+ * preface ruby_debug global Ruby variables with rdebug_.
+
+ * Change Debugger.start() to accept an optional options argument
+    :init => true saves things (like $0 and ARGV) necessary to
+     allow restart. Default: true
+    :post_mortem => true runs post-mortem on an uncaught exception
+     Default: false
+  
+   The old Debugger.start() is now renamed to Debugger.start_()
+
+ * split of line caching to an external gem. We now only allow setting
+   breakpoints on lines where it makes sense to do so.
+
+ * Incompatible enhancement: even return/end will now call event handler
+
+ See ChangeLog for full details, and the reference guide for more complete
+ documentation of these changes.
+
 0.10.0
+12/25/07
+
 - '-r' option can be used to require additional libraries.
 - --noquit option added to stay in debugger when the program exits
 - gdb-like --annotate option added. Can be used by front-ends to get information
@@ -27,7 +154,7 @@
 - INCOMPATIBLE CHANGE: "script" command removed. Use "source" command instead
   (same as gdb).
 - Run .rdebugrc on Debugger.start. Look for a file in the current directory and
-  run that instead the one in $HOME if that exists. Again, inspired and compatible
+  run that instead of the one in $HOME if that exists. Again, inspired by and compatible
   with gdb.
 - Changes compatible with Ruby 1.9. NOTE: this debugger will NOT work with
   Ruby 1.9
@@ -35,7 +162,7 @@
   is also cleared when leaving irb
 - help "foo" gives message "Undefined command "foo" rather than a list
   of help commands. (Message test is gdb's)
-- Add set linetrace+ - similar step+ for linetrace
+- Add set linetrace+ - similar to step+ for linetrace
 - Start unit tests.
 - Start a reference guide.
 

data/README

@@ -3,7 +3,8 @@
 == Overview
 
 ruby-debug is a fast implementation of the standard debugger debug.rb.
-The faster execution speed is achieved by utilizing a new hook Ruby C API.
+The faster execution speed is achieved by utilizing a new hook in the
+Ruby C API.
 
 == Requirements
 
@@ -14,6 +15,12 @@ are sometimes available), you'll need a C compiler and Ruby
 development headers, and a Make program so the extension in
 ruby-debug-base can be compiled when it is installed.
 
+To install on Microsoft Windows, unless you run under cygwin or mingw
+you'll need Microsoft Visual C++ 6.0 also known as VC6.
+http://rubyforge.org/tracker/index.php?func=detail&aid=16774&group_id=1900&atid=7436
+suggests why.
+
+
 == Install
 
 ruby-debug is provided as a RubyGem.  To install:
@@ -22,15 +29,37 @@ ruby-debug is provided as a RubyGem.  To install:
 
 This should also pull in <tt>ruby-debug-base</tt> as a dependency.
 
+(If you install ruby-debug-base explicitly, you can add in the <tt>--test</tt>
+option after "install" to have the regression test run before
+installing.)
+
 For Emacs support and the Reference Manual, get
 <tt>ruby-debug-extra</tt>.  This is not a RubyGem, you'll need a Make
 program and a POSIX shell. With this installed, run:
 
-<pre>
   sh ./configure
   make
-  make install
-</pre>
+  make test # optional, but a good idea
+  sudo make install
+
+
+==== Install on MS Windows
+
+Compiling under cygwin or mingw works like it does on Unix. 
+
+* Have Microsoft Visual C++ 6.0 (VC6) installed - exactly that version.
+
+* Set the appropriate environment variables.
+
+* run `nmake'.
+
+* Copy ruby_debug.so to `win32'.
+
+* Go to the ruby_debug root.
+
+* rake win32_gem
+
+* The file is in named `rdebug-debug-base-0.10.0-mswin32.gem'.
 
 == Usage
 
@@ -57,13 +86,21 @@ code execution at run time.
     ...
   end
 
+or
+
+  require 'ruby-debug' ; 
+  Debugger.start do 
+    ...
+    debugger
+  end
+
 When Kernel#debugger method is executed, the debugger is activated
 and you will be able to inspect and step through your code.
 
 == Performance
 
-The debug.rb script that comes with the standard Ruby library uses
-Kernel#set_trace_func API. Implementing the debugger in pure Ruby has
+The <tt>debug.rb</tt> script that comes with the standard Ruby library uses
+<tt>Kernel#set_trace_func</tt> API. Implementing the debugger in pure Ruby has
 a negative impact on the speed of your program execution. This is
 because the Ruby interpreter creates a Binding object each trace call,
 even though it is not being used most of the time. ruby-debug moves

data/Rakefile

@@ -6,50 +6,93 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 
 SO_NAME = "ruby_debug.so"
+ROOT_DIR = File.dirname(__FILE__)
+VERSION_FILE = ROOT_DIR + '/VERSION'
 
-# ------- Default Package ----------
-RUBY_DEBUG_VERSION = open("ext/ruby_debug.c"){|f| f.grep(/^#define DEBUG_VERSION/).first[/"(.+)"/,1]}
+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[
   'AUTHORS',
   'CHANGES',
   'LICENSE',
   'README',
+  'VERSION',
   'Rakefile',
 ]                        
 
-CLI_TEST_FILE_LIST = 'test/**/*test-*.rb'
+CLI_TEST_FILE_LIST = FileList['test/cli/commands/unit/*.rb',
+                              'test/cli/commands/*_test.rb', 
+                              'test/cli/**/*_test.rb', 
+                              'test/test-*.rb'] 
 CLI_FILES = COMMON_FILES + FileList[
   "cli/**/*",
   'ChangeLog',
   'bin/*',
   'doc/rdebug.1',
-  'test/**/*.cmd',
-  'test/**/*.right',
-  'test/**/gcd.rb',
-  'test/**/helper.rb',
-  'test/**/info-var-bug.rb',
-  'test/**/tdebug.rb',
-  'test/**/test-*.cmd',
+  'test/rdebug-save.1',
+  'test/**/data/*.cmd',
+  'test/**/data/*.right',
+  'test/config.yaml',
+  'test/**/*.rb',
+  'rdbg.rb',
   'runner.sh',
-   CLI_TEST_FILE_LIST,                                    
+   CLI_TEST_FILE_LIST
 ]
 
-BASE_TEST_FILE_LIST = 'test/test-ruby-debug-base.rb'
+BASE_TEST_FILE_LIST = %w(
+  test/base/base.rb 
+  test/base/binding.rb 
+  test/base/catchpoint.rb
+  test/base/reload_bug.rb 
+)
+
 BASE_FILES = COMMON_FILES + FileList[
-  'lib/**/*',
-  'ext/ChangeLog',
-  'ext/ruby_debug.c',
+  'ext/breakpoint.c',
   'ext/extconf.rb',
+  'ext/ruby_debug.c',
+  'ext/ruby_debug.h',
   'ext/win32/*',
+  'lib/**/*',
   BASE_TEST_FILE_LIST,
 ]
 
 desc "Test everything."
-test_task = task :test => :lib do 
+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 << ['./ext', './lib', './cli']
-    t.pattern = CLI_TEST_FILE_LIST
+    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
 end
@@ -74,9 +117,9 @@ end
 
 desc "Create a GNU-style ChangeLog via svn2cl"
 task :ChangeLog do
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk")
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/ext -o ext/ChangeLog")
-  system("svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/lib -o lib/ChangeLog")
+  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")
 end
 
 # Base GEM Specification
@@ -92,19 +135,19 @@ 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 = ruby_debug_version
 
   spec.author = "Kent Sibilev"
   spec.email = "ksibilev@yahoo.com"
   spec.platform = Gem::Platform::RUBY
   spec.require_path = "lib"
   spec.extensions = ["ext/extconf.rb"]
-  spec.autorequire = "ruby-debug-base"
   spec.files = BASE_FILES.to_a  
 
   spec.required_ruby_version = '>= 1.8.2'
   spec.date = Time.now
   spec.rubyforge_project = 'ruby-debug'
+  spec.add_dependency('linecache', '>= 0.3')
   
   spec.test_files = FileList[BASE_TEST_FILE_LIST]
   
@@ -122,7 +165,7 @@ cli_spec = Gem::Specification.new do |spec|
 A generic command line interface for ruby-debug.
 EOF
 
-  spec.version = RUBY_DEBUG_VERSION
+  spec.version = ruby_debug_version
 
   spec.author = "Kent Sibilev"
   spec.email = "ksibilev@yahoo.com"
@@ -130,13 +173,13 @@ EOF
   spec.require_path = "cli"
   spec.bindir = "bin"
   spec.executables = ["rdebug"]
-  spec.autorequire = "ruby-debug"
   spec.files = CLI_FILES.to_a
 
   spec.required_ruby_version = '>= 1.8.2'
   spec.date = Time.now
   spec.rubyforge_project = 'ruby-debug'
-  spec.add_dependency('ruby-debug-base', RUBY_DEBUG_VERSION)
+  spec.add_dependency('columnize', '>= 0.1')
+  spec.add_dependency('ruby-debug-base', "~> #{ruby_debug_version}.0")
   
   # FIXME: work out operational logistics for this
   # spec.test_files = FileList[CLI_TEST_FILE_LIST]
@@ -159,7 +202,8 @@ task :default => [:package]
 # Windows specification
 win_spec = base_spec.clone
 win_spec.extensions = []
-win_spec.platform = Gem::Platform::WIN32
+## win_spec.platform = Gem::Platform::WIN32 # deprecated
+win_spec.platform = 'mswin32'
 win_spec.files += ["lib/#{SO_NAME}"]
 
 desc "Create Windows Gem"
@@ -170,23 +214,23 @@ task :win32_gem do
   target = File.join(current_dir, "lib", SO_NAME)
   cp(source, target)
 
-  # Create the gem, then move it to pkg
-	Gem::Builder.new(win_spec).build
-	gem_file = "#{win_spec.name}-#{win_spec.version}-#{win_spec.platform}.gem"
+  # Create the gem, then move it to pkg.
+  Gem::Builder.new(win_spec).build
+  gem_file = "#{win_spec.name}-#{win_spec.version}-#{win_spec.platform}.gem"
   mv(gem_file, "pkg/#{gem_file}")
 
-  # Remove win extension fro top level directory	
-	rm(target)
+  # Remove win extension from top level directory.
+  rm(target)
 end
 
 desc "Publish ruby-debug to RubyForge."
 task :publish do 
   require 'rake/contrib/sshpublisher'
   
-  # Get ruby-debug path
+  # Get ruby-debug path.
   ruby_debug_path = File.expand_path(File.dirname(__FILE__))
 
-  publisher = Rake::SshDirPublisher.new("kent@rubyforge.org",
+  Rake::SshDirPublisher.new("kent@rubyforge.org",
         "/var/www/gforge-projects/ruby-debug", ruby_debug_path)
 end
 
@@ -205,16 +249,63 @@ end
 # ---------  RDoc Documentation ------
 desc "Generate rdoc documentation"
 Rake::RDocTask.new("rdoc") do |rdoc|
-  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_dir = 'doc/rdoc'
   rdoc.title    = "ruby-debug"
   # Show source inline with line numbers
   rdoc.options << "--inline-source" << "--line-numbers"
   # Make the readme file the start page for the generated html
   rdoc.options << '--main' << 'README'
   rdoc.rdoc_files.include('bin/**/*',
+                          'cli/ruby-debug/commands/*.rb',
+                          'cli/ruby-debug/*.rb',
                           'lib/**/*.rb',
                           'ext/**/ruby_debug.c',
                           'README',
                           'LICENSE')
 end
 
+desc "Publish the release files to RubyForge."
+task :rubyforge_upload do
+  `rubyforge login`
+  release_command = "rubyforge add_release #{PKG_NAME} #{PKG_NAME} '#{PKG_NAME}-#{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.gem"
+  puts release_command
+  system(release_command)
+end
+
+PKG_NAME      = 'ruby-debug'
+desc "Publish the release files to RubyForge."
+task :rubyforge_upload do
+  `rubyforge login`
+  for pkg_name in ['ruby-debug', 'ruby-debug-base'] do
+    pkg_file_name = "#{pkg_name}-#{pkg_version}"
+    release_command = "rubyforge add_release ruby-debug #{pkg_name} '#{pkg_file_name}' pkg/#{pkg_file_name}.gem"
+    puts release_command
+    system(release_command)
+  end
+end
+
+def install(spec, *opts)
+  args = ['gem', 'install', "pkg/#{spec.name}-#{spec.version}.gem"] + opts
+  args.unshift 'sudo' unless 0 == Process.uid
+  system(*args)
+end
+
+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')
+  end
+end    
+
+task :install_full => :package do
+  Dir.chdir(File::dirname(__FILE__)) do
+    install(base_spec)
+    install(cli_spec)
+  end
+end    
+
+task :make_version_file do 
+  make_version_file 
+end