ruby-debug 0.10.3 → 0.10.4

data/Rakefile

@@ -6,17 +6,37 @@ require 'rake/rdoctask'
 require 'rake/testtask'
 
 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
 
-# ------- Default Package ----------
-RUBY_DEBUG_VERSION = open("ext/ruby_debug.c") do |f| 
-  f.grep(/^#define DEBUG_VERSION/).first[/"(.+)"/,1]
+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',
 ]                        
 
@@ -29,17 +49,23 @@ CLI_FILES = COMMON_FILES + FileList[
   'ChangeLog',
   'bin/*',
   'doc/rdebug.1',
+  'test/rdebug-save.1',
   'test/**/data/*.cmd',
   'test/**/data/*.right',
+  '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/catchpoint.rb
+  test/base/reload_bug.rb 
+)
+
 BASE_FILES = COMMON_FILES + FileList[
   'ext/breakpoint.c',
   'ext/extconf.rb',
@@ -51,9 +77,12 @@ BASE_FILES = COMMON_FILES + FileList[
 ]
 
 desc "Test everything."
-task :test => :test_base 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.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
@@ -62,7 +91,7 @@ end
 desc "Test ruby-debug-base."
 task :test_base => :lib do 
   Rake::TestTask.new(:test_base) do |t|
-    t.libs << ['./ext', './lib']
+    t.libs += ['./ext', './lib']
     t.test_files = FileList[BASE_TEST_FILE_LIST]
     t.verbose = true
   end
@@ -88,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
@@ -106,7 +135,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 = ruby_debug_version
 
   spec.author = "Kent Sibilev"
   spec.email = "ksibilev@yahoo.com"
@@ -136,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"
@@ -150,7 +179,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', "~> #{ruby_debug_version}.0")
   
   # FIXME: work out operational logistics for this
   # spec.test_files = FileList[CLI_TEST_FILE_LIST]
@@ -228,6 +257,7 @@ Rake::RDocTask.new("rdoc") do |rdoc|
   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',
@@ -253,3 +283,29 @@ task :rubyforge_upload do
     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

data/VERSION

@@ -0,0 +1,3 @@
+# This file was created automatically from data in ext/ruby_debug.c via:
+# 	rake :make_version_file. 
+0.10.4

data/bin/rdebug

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
 
 #=== Summary
 #
@@ -111,7 +112,7 @@ def debug_program(options)
   # Make sure Ruby script syntax checks okay.
   # Otherwise we get a load message that looks like rdebug has 
   # a problem. 
-  output = `ruby -c #{Debugger::PROG_SCRIPT} 2>&1`
+  output = `ruby -c #{Debugger::PROG_SCRIPT.inspect} 2>&1`
   if $?.exitstatus != 0 and RUBY_PLATFORM !~ /mswin/
     puts output
     exit $?.exitstatus 

data/cli/ruby-debug.rb

@@ -35,7 +35,7 @@ module Debugger
     # if the call stack is truncated.
     attr_accessor :start_sentinal 
     
-    attr_reader :thread, :control_thread
+    attr_reader :thread, :control_thread, :cmd_port, :ctrl_port
 
     def interface=(value) # :nodoc:
       handler.interface = value
@@ -58,15 +58,16 @@ module Debugger
         cmd_port, ctrl_port = port, port + 1
       end
 
-      start_control(host, ctrl_port)
+      ctrl_port = start_control(host, ctrl_port)
       
       yield if block_given?
       
       mutex = Mutex.new
       proceed = ConditionVariable.new
       
+      server = TCPServer.new(host, cmd_port)
+      @cmd_port = cmd_port = server.addr[1]
       @thread = DebugThread.new do
-        server = TCPServer.new(host, cmd_port)
         while (session = server.accept)
           self.interface = RemoteInterface.new(session)
           if wait_connection
@@ -86,15 +87,17 @@ module Debugger
     
     def start_control(host = nil, ctrl_port = PORT + 1) # :nodoc:
       raise "Debugger is not started" unless started?
-      return if defined?(@control_thread) && @control_thread
+      return @ctrl_port if defined?(@control_thread) && @control_thread
+      server = TCPServer.new(host, ctrl_port)
+      @ctrl_port = server.addr[1]
       @control_thread = DebugThread.new do
-        server = TCPServer.new(host, ctrl_port)
         while (session = server.accept)
           interface = RemoteInterface.new(session)
           processor = ControlCommandProcessor.new(interface)
           processor.process_commands
         end
       end
+      @ctrl_port
     end
     
     #

data/cli/ruby-debug/command.rb

@@ -6,14 +6,32 @@ module Debugger
   RUBY_DEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
     defined?(RUBY_DEBUG_DIR)
 
-  class Command # :nodoc:
+  # A Debugger::Command object is is the base class for commands that
+  # implement a single debugger command. Individual debugger commands
+  # will be a subclass of this. The singleton class object is the
+  # command manager for all commands.
+  # 
+  # Each debugger command is expected to implement the following methods:
+  # _regexp_::   A regular expression which input strings are matched
+  #              against. If we have a match, run this command. 
+  #              It is the ruby-debug programmer's responsibility
+  #              to make sure that these regular expressions match disjoint
+  #              sets of strings. Otherwise one is arbitrarily used.
+  # _execute_::  Ruby code that implements the command.
+  # _help_::     Should return a String containing descriptive help for
+  #              the commmand. Used by the 'help' command Debugger::HelpCommand
+  # _help_command_:: The name of the command listed via help.
+  # 
+  # _help_ and _help_command_ methods are singleton methods, not 
+  # instance methods like _regexp_ and _execute_.
+  class Command
     SubcmdStruct=Struct.new(:name, :min, :short_help, :long_help) unless
       defined?(SubcmdStruct)
 
     include Columnize
 
-    # Find param in subcmds. param id downcased and can be abbreviated
-    # to the minimum length listed in the subcommands
+    # Find _param_ in _subcmds_. The _param_ id downcased and can be
+    # abbreviated to the minimum length listed in the subcommands
     def find(subcmds, param)
       param.downcase!
       for try_subcmd in subcmds do
@@ -26,6 +44,8 @@ module Debugger
     end
 
     class << self
+      # An Array containing Debugger::Command classes that implment each
+      # of the debugger commands.
       def commands
         @commands ||= []
       end
@@ -46,6 +66,11 @@ module Debugger
         commands << klass
       end 
 
+      # Read in and "include" all the subclasses of the
+      # Debugger::Command class. For example
+      # Debugger::QuitCommand is one of them. The list of Ruby
+      # files to read are all the files that end .rb in directory
+      # Debugger::RUBY_DEBUG_DIR
       def load_commands
         Dir[File.join(Debugger.const_get(:RUBY_DEBUG_DIR), 'commands', '*')].each do |file|
           require file if file =~ /\.rb$/
@@ -75,7 +100,9 @@ module Debugger
         @@settings_map ||= {}
       end
       private :settings_map
-      
+
+      # Returns a Hash of Debugger settings, @settings. If doesn't exist
+      # we create a @settings hash with [] setter and getter and return that.
       def settings
         unless true and defined? @settings and @settings
           @settings = Object.new
@@ -165,10 +192,17 @@ module Debugger
       @state.print(*args)
     end
 
+    # Called when we are about to do a dangerous operation. _msg_
+    # contains a prompt message. Return _true_ if confirmed or _false_
+    # if not confirmed.
     def confirm(msg)
       @state.confirm(msg) == 'y'
     end
 
+    # debug_eval like Kernel.eval or Object.instance_eval but using
+    # the bindings for the debugged program. If there is a
+    # syntax-error like exception in running eval, print an
+    # appropriate message and throw :debug_error
     def debug_eval(str, b = get_binding)
       begin
         val = eval(str, b)
@@ -186,6 +220,10 @@ module Debugger
       end
     end
 
+    # debug_eval like Kernel.eval or Object.instance_eval but using
+    # the bindings for the debugged program. If there is a syntax
+    # error kind of exception in running eval, no warning is given and
+    # nil is returned.
     def debug_silent_eval(str)
       begin
         eval(str, get_binding)
@@ -194,6 +232,7 @@ module Debugger
       end
     end
 
+    # Return a binding object for the debugged program.
     def get_binding
       @state.context.frame_binding(@state.frame_pos)
     end

data/cli/ruby-debug/commands/breakpoints.rb

@@ -81,7 +81,9 @@ module Debugger
           errmsg "We are not in a state we can add breakpoints.\n"
           return 
         end
-        b = Debugger.add_breakpoint file, line, expr
+        brkpt_filename = File.basename(brkpt_filename) if 
+          Command.settings[:basename]
+        b = Debugger.add_breakpoint brkpt_filename, line, expr
         print "Breakpoint %d file %s, line %s\n", b.id, brkpt_filename, line.to_s
         unless syntax_valid?(expr)
           errmsg("Expression \"#{expr}\" syntactically incorrect; breakpoint disabled.\n")

data/cli/ruby-debug/commands/catchpoint.rb

@@ -43,9 +43,11 @@ module Debugger
 
       def help(cmd)
         %{
-          cat[ch]\t\t\tsame as "info catch"
-          cat[ch] <exception-name>\tIntercept <exception-name> when there would otherwise be is no handler 
-for it.
+          cat[ch]\t\tsame as "info catch"
+          cat[ch] <exception-name> [on|off]
+\tIntercept <exception-name> when there would otherwise be no handler.
+\tWith an "on" or "off", turn handling the exception on or off.
+          cat[ch] off\tdelete all catchpoints
         }
       end
     end

data/cli/ruby-debug/commands/eval.rb

@@ -3,7 +3,8 @@ module Debugger
     def run_with_binding
       binding = @state.context ? get_binding : TOPLEVEL_BINDING
       $__dbg_interface = @state.interface
-      eval(<<-EOC, binding)
+       begin
+         eval(<<-EOC, binding)
         __dbg_verbose_save=$VERBOSE; $VERBOSE=false
         def dbg_print(*args)
           $__dbg_interface.print(*args)
@@ -16,6 +17,8 @@ module Debugger
         end
         $VERBOSE=__dbg_verbose_save
       EOC
+      rescue 
+      end
       yield binding
     ensure
       $__dbg_interface = nil

data/cli/ruby-debug/commands/frame.rb

@@ -101,7 +101,7 @@ module Debugger
         end
       end
       print file_line
-      if ENV['EMACS'] && adjust
+      if Debugger.inside_emacs? && adjust
         fmt = (Debugger.annotate.to_i > 1 ?
                "\032\032source %s:%d\n" : "\032\032%s:%d\n")
         print fmt % [CommandProcessor.canonic_file(file), line]
@@ -168,7 +168,8 @@ module Debugger
 
       end
       if truncated_callstack?(@state.context, Debugger.start_sentinal)
-        print "Warning: saved frames may be incomplete; compare with caller(0).\n" 
+        print "Warning: saved frames may be incomplete;\n"
+        print "compare debugger backtrace (bt) with Ruby caller(0).\n" 
       end
     end
 
@@ -198,7 +199,7 @@ The position of the current frame is marked with -->.  }
 
   class UpCommand < Command # :nodoc:
     def regexp
-      /^\s* u(?:p)? (?:\s+(.*))?$/x
+      /^\s* u(?:p)? (?:\s+(\S+))? $/x
     end
 
     def execute
@@ -222,7 +223,7 @@ The position of the current frame is marked with -->.  }
 
   class DownCommand < Command # :nodoc:
     def regexp
-      /^\s* down (?:\s+(.*))? .*$/x
+      /^\s* down (?:\s+(\S+))? $/x
     end
 
     def execute
@@ -255,8 +256,7 @@ The position of the current frame is marked with -->.  }
 
     def execute
       if not @match[1]
-        errmsg "Missing a frame number argument.\n"
-        return
+        pos = 0
       else
         pos = get_int(@match[1], "Frame")
         return unless pos
@@ -280,8 +280,9 @@ The position of the current frame is marked with -->.  }
 
       def help(cmd)
         %{
-          f[rame] frame-number [thread thread-number]
-          Move the current frame to the specified frame number.
+          f[rame] [frame-number [thread thread-number]]
+          Move the current frame to the specified frame number, or the
+          0 if no frame-number has been given.
 
           A negative number indicates position from the other end.  So
           'frame -1' moves to the oldest frame, and 'frame 0' moves to
@@ -289,10 +290,10 @@ The position of the current frame is marked with -->.  }
 
           Without an argument, the command prints the current stack
           frame. Since the current position is redisplayed, it may trigger a
-          resyncronization if there is a front end also watching over
+          resynchronization if there is a front end also watching over
           things. 
 
-          If a thread number is given then we set the context for evaluating
+          If a thread number is given, then we set the context for evaluating
           expressions to that frame of that thread. 
         }
       end