debugger 1.0.0.rc1

data/INSTALL.SVN

@@ -0,0 +1,154 @@
+Building and Installing ruby-debug from rubyforge's Subversion Repository (svn)
+
+The below are Unix-centric instructions. If you have Microsoft Windows see 
+the section on building Microsoft Windows.
+
+
+0. Prerequisites: To build the package you'll need at a minimum:
+
+ - Ruby (of course). Currently only version 1.8.6 and above but not 
+   version 1.9.x work.
+ - Ruby development headers. This typically includes a file called "ruby.h"
+ - A C compiler like GNU C (gcc)
+ - Rake
+ - Subversion (svn)
+
+If you want to build the documentation and install Emacs files, you'll
+also need:
+
+ - a POSIX shell
+ - autoconf
+ - automake
+ - GNU Make
+ - texinfo
+
+1. Basic package checkout and installation 
+
+Check out the trunk of repository following the instructions at 
+http://rubyforge.org/scm/?group_id=1900  For example on a Unixy system,
+this may work:
+
+  mkdir ruby-debug
+  cd ruby-debug
+  svn checkout svn://rubyforge.org/var/svn/ruby-debug/trunk trunk
+
+In order to make the Ruby gems, ruby-debug and ruby-debug-base, get
+yourself into the trunk directory after the code has been checked out and run:
+
+  cd trunk # This is the same trunk checked out above.
+  rake package
+
+If all goes well you should have some gem files put in the directory
+pkg. Use the gem command to install that. 
+
+  sudo gem install ruby-debug-*.gem   # See gem help for other possibilities
+
+If all goes well the rdebug script has been installed ruby-debug is
+now ready to run. But if everything goes well you might want to run
+the built-in regression tests to make sure everything is okay.
+See step 3 below.
+
+If the gem install didn't work,'t there may be a problem with your C
+compiler or the Ruby headers are not installed.
+
+2. Trying out without installing. 
+
+You don't have to build a gem file to try out ruby debug. In fact when
+developing new features for ruby-debug, developers often you want to
+try it out *before* installing.  If you have a problem in the latter
+part of step 1 you may want to try this approach since we go into a
+little more detail as to what happens under the covers when you do the
+gem install.
+
+Run (from trunk)
+  rake lib
+
+This creates a Makefile and builds the ruby-debug shared library. (On
+Unix the name is ruby_debug.so).
+
+Once this is done you can run the debugger as you would rdebug using the
+script rdbg.rb. For example (again from trunk)
+
+  ./rdbg.rb ~/my-ruby-program.rb
+
+3. Running the Regression tests
+  
+We've put together some basic tests to make sure ruby-debug is doing
+what we think it should do. To run these (from trunk):
+
+  rake test
+
+If you didn't build the ruby-debug shared library and skipped step 2,
+don't worry "rake test" will do step 2 for you. You should see a line that
+ends something like:
+
+  Finished in 2.767579 seconds.
+
+  12 tests, 35 assertions, 0 failures, 0 errors
+
+The number of seconds, tests, and assertions may be different from the
+above. However you *should* see exactly "0 failures, 0 errors".
+
+4. Building the documentation and testing/installing Emacs files
+
+Of course, I recommend you read the ruby-debug manual that comes with
+the package. If you have the prerequisites described above, run this
+once:
+  sh ./autogen.sh
+
+Then run:
+  ./configure
+  make
+  make test           # Runs Emacs regression tests
+  sudo make install   # Or arrange to do this as root
+ 
+
+Microsoft Windows
+
+A problem here seems to be that the "One-click" install is compiled
+using Microsoft Visual Studio C 6 which is not sold anymore and is
+rather old. 
+
+Instead I suggest building via mingw/msys. 
+http://eigenclass.org/hiki.rb?cmd=view&p=cross+compiling+rcovrt&key=mingw has instructions on how to do. Some amendments to these instructions. 
+
+First, those instructions are a little GNU/Linux centric. If you are
+using Ubuntu or Debian, then this should be the easiest to follow the
+instructions. On Ubuntu or Debian there is a mingw3 Debian
+package. Installing that will give you the cross compiler that is a
+prerequisite. Alternatively if you are running MS Windows I notice
+that cygwin also has a mingw package. Or possibly you could use MinGW
+directly. For other OS's you might have to build a cross-compiler,
+i.e. gcc which emits win32 code and can create a win32 DLL.
+
+After you have a cross compiler you need to download the Ruby source
+and basically build a ruby interpreter. The cross-compile.sh script
+works although when I downloaded it, it had lots of blank space at the
+beginning which will mess up the Unix magic interpretation. That is
+remove the blanks in front of "#/bin/sh"
+
+On my system, this script fails in running "make ruby" because the
+fake.rb that got created needed to have a small change:
+
+	    ALT_SEPARATOR = "\"; \
+should be 
+	    ALT_SEPARATOR = "\\"; \
+
+After fixing this, run 
+  make ruby
+Also, I needed to run
+  make rubyw
+
+And then "make install" as indicated. 
+
+Once all of that's in place, the place you want be is in
+ruby-debug/trunk/ext/win32, not ruby-debug/ext. 
+
+So let's say you've installed the cross-compiled install ruby in
+/usr/local/ruby-mingw32/. Here then are the commands to build ruby-debug-base-xxx-mswin32.gem
+
+   cd .../ruby-debug/trunk/ext/win32 
+   ruby -I /usr/local/ruby-mingw32/lib/ruby/1.8/i386-mingw32 ../extconf.rb
+   make # Not rake
+   cd ../..   # back in ruby-debug/trunk
+   rake win32_gem

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (C) 2005  Kent Sibilev <ksibilev@yahoo.com>
+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/Makefile.am

@@ -0,0 +1,14 @@
+SUBDIRS = doc emacs
+PHONY = test ChangeLogs
+test: check
+ChangeLogs: ChangeLog doc/ChangeLog emacs/ChangeLog lib/ChangeLog 
+ChangeLog:
+	svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk  \
+                 cli test bin AUTHORS CHANGES LICENSE README runner.sh -o ChangeLog
+lib/ChangeLog:
+	svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk \
+                 lib ext -o lib/ChangeLog
+doc/ChangeLog:
+	svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/doc -o doc/ChangeLog
+emacs/ChangeLog:
+	svn2cl --authors=svn2cl_usermap svn://rubyforge.org/var/svn/ruby-debug/trunk/emacs -o emacs/ChangeLog

data/OLD_README

@@ -0,0 +1,122 @@
+*************************************************************
+
+  NOTE: For Ruby 1.9 installation instructions, please see:
+
+     http://wiki.github.com/mark-moseley/ruby-debug
+
+*************************************************************
+
+= ruby-debug
+
+== Overview
+
+ruby-debug is a fast implementation of the standard debugger debug.rb.
+The faster execution speed is achieved by utilizing a new hook in the
+Ruby C API.
+
+== Requirements
+
+ruby-debug requires Ruby 1.8.4 or higher.
+
+Unless you get the packages as a binary (Microsoft Windows binaries
+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:
+
+<tt>gem install ruby-debug</tt>
+
+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:
+
+  sh ./configure
+  make
+  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
+
+There are two ways of running ruby-debug.
+
+=== rdebug executable:
+
+$ rdebug <your-script>
+
+When you start your script this way, the debugger will stop at
+the first line of code in the script file. So you will be able 
+to set up your breakpoints.
+
+=== ruby-debug API
+
+The second way is to use the ruby-debug API to interrupt your
+code execution at run time.
+
+  require 'ruby-debug' ; Debugger.start
+  ...
+  def your_method
+    ...
+    debugger
+    ...
+  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 <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
+most of the functionality for Binding access and for breakpoint
+testing to a native extension. Because this code is in C and because
+and can be selectively enabled or disabled, the overhead in running
+your program can be minimized.
+
+== License
+
+See LICENSE for license information.

data/README.md

@@ -0,0 +1,10 @@
+## Description
+A fork of ruby-debug19 that works on 1.9.3 and installs easily.
+
+## Usage
+
+```ruby
+require 'debugger'; debugger
+```
+
+TODO

data/Rakefile

@@ -0,0 +1,266 @@
+#!/usr/bin/env rake
+# -*- Ruby -*-
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new('ruby_debug')
+
+SO_NAME = "ruby_debug.so"
+
+# ------- Default Package ----------
+RUBY_DEBUG_VERSION = open("ext/ruby_debug/ruby_debug.c") do |f| 
+  f.grep(/^#define DEBUG_VERSION/).first[/"(.+)"/,1]
+end
+
+RUBY_DEBUG_TEENY = ".0"
+RUBY_DEBUG_BASE_TEENY = ".0"
+
+COMMON_FILES = FileList[
+  'AUTHORS',
+  'CHANGES',
+  'LICENSE',
+  'README',
+  'Rakefile',
+]                        
+
+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/**/data/*.cmd',
+  'test/**/data/*.right',
+  'test/**/*.rb',
+  'rdbg.rb',
+   CLI_TEST_FILE_LIST
+]
+
+BASE_TEST_FILE_LIST = %w(
+  test/base/base.rb 
+  test/base/binding.rb 
+  test/base/catchpoint.rb)
+BASE_FILES = COMMON_FILES + FileList[
+  'ext/ruby_debug/breakpoint.c',
+  'ext/ruby_debug/extconf.rb',
+  'ext/ruby_debug/ruby_debug.c',
+  'ext/ruby_debug/ruby_debug.h',
+  'ext/win32/*',
+  'lib/**/*',
+  BASE_TEST_FILE_LIST,
+]
+
+desc "Test everything."
+task :test => :test_base do 
+  Rake::TestTask.new(:test) do |t|
+    t.libs << './ext'
+    t.libs << './lib'
+    t.libs << './cli'
+    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'
+    t.libs << './lib'
+    t.test_files = FileList[BASE_TEST_FILE_LIST]
+    t.verbose = true
+  end
+end
+
+desc "Test everything - same as test."
+task :check => :test
+
+desc "Create the core ruby-debug shared library extension"
+task :lib do
+  Dir.chdir("ext") do
+    system("#{Gem.ruby} extconf.rb && make")
+  end
+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
+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")
+end
+
+# Base GEM Specification
+base_spec = Gem::Specification.new do |spec|
+  spec.name = "ruby-debug-base19"
+  
+  spec.homepage = "http://rubyforge.org/projects/ruby-debug19/"
+  spec.summary = "Fast Ruby debugger - core component"
+  spec.description = <<-EOF
+ruby-debug-base19 is a fast implementation of the standard Ruby debugger debug.rb.
+It is implemented by utilizing a new Ruby C API hook. The core component 
+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 + RUBY_DEBUG_BASE_TEENY
+
+  spec.authors = ["Kent Sibilev", "Mark Moseley"]
+  spec.email = "mark@fast-software.com"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "lib"
+  spec.extensions = ["ext/ruby_debug/extconf.rb"]
+  spec.files = BASE_FILES.to_a  
+
+  spec.required_ruby_version = '>= 1.8.2'
+  spec.date = Time.now
+  spec.rubyforge_project = 'ruby-debug19'
+  spec.add_dependency('ruby_core_source', '>= 0.1.4')
+  spec.add_dependency('linecache19', '>= 0.5.11')
+  
+  spec.test_files = FileList[BASE_TEST_FILE_LIST]
+  
+  # rdoc
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README', 'ext/ruby_debug/ruby_debug.c']
+end
+
+cli_spec = Gem::Specification.new do |spec|
+  spec.name = "ruby-debug19"
+  
+  spec.homepage = "http://rubyforge.org/projects/ruby-debug19/"
+  spec.summary = "Command line interface (CLI) for ruby-debug-base19"
+  spec.description = <<-EOF
+A generic command line interface for ruby-debug.
+EOF
+
+  spec.version = RUBY_DEBUG_VERSION + RUBY_DEBUG_TEENY
+
+  spec.authors = ["Kent Sibilev", "Mark Moseley"]
+  spec.email = "mark@fast-software.com"
+  spec.platform = Gem::Platform::RUBY
+  spec.require_path = "cli"
+  spec.bindir = "bin"
+  spec.executables = ["rdebug"]
+  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('columnize', '>= 0.3.1')
+  spec.add_dependency('linecache19', '>= 0.5.11')
+  spec.add_dependency('ruby-debug-base19', '>= 0.12.0')
+  
+  # FIXME: work out operational logistics for this
+  # spec.test_files = FileList[CLI_TEST_FILE_LIST]
+
+  # rdoc
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README']
+end
+
+# Rake task to build the default package
+Rake::GemPackageTask.new(base_spec) do |pkg|
+  pkg.need_tar = true
+end
+Rake::GemPackageTask.new(cli_spec) do |pkg|
+  pkg.need_tar = true
+end
+
+task :default => [:package]
+
+# Windows specification
+win_spec = base_spec.clone
+win_spec.extensions = []
+## win_spec.platform = Gem::Platform::WIN32 # deprecated
+win_spec.platform = 'mswin32'
+win_spec.files += ["lib/#{SO_NAME}"]
+
+desc "Create Windows Gem"
+task :win32_gem do
+  # Copy the win32 extension the top level directory
+  current_dir = File.expand_path(File.dirname(__FILE__))
+  source = File.join(current_dir, "ext", "win32", SO_NAME)
+  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"
+  mv(gem_file, "pkg/#{gem_file}")
+
+  # 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.
+  ruby_debug_path = File.expand_path(File.dirname(__FILE__))
+
+  Rake::SshDirPublisher.new("kent@rubyforge.org",
+        "/var/www/gforge-projects/ruby-debug", ruby_debug_path)
+end
+
+desc "Remove built files"
+task :clean do
+  cd "ext" do
+    if File.exists?("Makefile")
+      sh "make clean"
+      rm  "Makefile"
+    end
+    derived_files = Dir.glob(".o") + Dir.glob("*.so")
+    rm derived_files unless derived_files.empty?
+  end
+end
+
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
+  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',
+                          '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