ruby-debug-base 0.10.4-java → 0.10.5.rc1-java

data/AUTHORS

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

data/CHANGES

@@ -0,0 +1,366 @@
+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
+
+ - 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
+  without polling
+- Fixed 'var const' command. Issue #10847.
+- Using pretty-print for all var commands.
+- Better error reporting for commands that require a numeric argument.
+- Fixed Kernel#binding_n method
+- Add option -d ($DEBUG = true) and --verbose. Make -v work like ruby.
+- Remove debugger messages caused when warnings are turned on.
+- "info" and "show" commands added. "set" made more like gdb's
+  set. subcommands can be abbreviated and are case insensitive.
+- restart program if it terminates normally and we've got a tty and 
+  we stop on the first statement. 
+- help is in tidy column format. method lists are shown that way as well.
+  the "width" setting ("set/show width") is used  for the line width
+- stack traces now show parameter names and types. "info args" lists just
+  the parameters (with the most recent values, not the values at call time).
+- post-mortem "exit" bug fixed. 
+- More Emacs-friendly: rdebug-track.el will track location inside an Emacs
+  shell. Emacs position information is shown in breakpoints and catchpoints
+  similar to gdba. Commands to position in another window a unit test traceback
+  or ruby traceback. Much more work invisioned for Emacs.
+- INCOMPATIBLE CHANGE: "break" now sets a breakpoint on the current line
+  (same as gdb). Use "info break" for a list of breakpoints.
+- 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 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
+- leaving irb shows position same as entering debugger; "list" position
+  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 to step+ for linetrace
+- Start unit tests.
+- Start a reference guide.
+
+0.9.3
+- Fixed if..elsif..end stepping.
+- From irb session Ctrl-C or 'cont' command continues execution without showing the debugger prompt.
+- Added Debugger.settings method to programatically modify command settings.
+- Added Kernel#breakpoint as alias to Kernel#debugger is the former is not already defined.
+
+0.9.2
+- Fixed file comparison in Windows platform.
+- Added setter methods to Breakpoint properties
+- Added breakpoint hit condition functionality (not available via CLI yet) and methods:
+    Breakpoint:hit_count
+    Breakpoint:hit_value[=]
+    Breakpoint:hit_condition[=]
+
+0.9.1
+- Fixed incorrect stack calculation.
+- Context#stop_next= method aliased as Context#step.
+- Added the 'force' parameter to Context#step_over.
+- Added the 'force' parameter to Context#step.
+- 'next+/step+' commands forces to move to another line
+- Added a new 'forcestep' setting.
+
+0.9
+- Kernel#debugger method will start the debugger if it's not running.
+- Added Context#stop_reason method.
+- Calling a method with a block will create a new frame. This changes the behavior of 'next' command. So in order to step into a block, 'step' command must be used. That fixes bug #9629.
+- Added the possibility to add a temporary context-specific breakpoint. Context#breakpoint and Context#set_breakpoint methods are added. 
+- 'cont' command now accepts a numerical parameter which implements 'Continue until line' behavior.
+- Added new Context.frame_class method
+- Added new 'framefullpath' setting.
+- Added new 'frameclassname' setting.
+- All Ruby's 'eval' and require/load methods create a new frame. Fixes bug #9686.
+
+0.8.1
+- Added a shortcut module 'debugger'. require "ruby-debug/debugger" will start the debugger and stop at the next line (similar to require 'debug').
+- Fixed remote debugging.
+
+0.8
+- Extract the base debugger API into a separate gem (ruby-debug-base), so it will be easier to add a new interface.
+- Added 'set autoirb' setting.
+- Bugfixes.
+
+0.7.5
+- Fixed 'reload on' command
+- 'reload on' command is removed in favor of 'set autoreload'
+- rdebug will evaluate ~/.rdebugrc script on startup
+
+0.7.4
+- Added a workaround of the Ruby interpreter problem where a method created with Module#define_method 
+  and which raises an exception doesn't trigger a :return event, this way screwing the stack trace.
+- Fixed a situation of an array 'out of bounds' access.
+- Fixed the help for 'where' command.
+
+0.7.3
+- Fixed a case when a frame is not popped up properly.
+- Removed Context.ignore= method, since it can result with the segmentation fault error.
+- Fixed the case when Context#suspend may effect the state of the thread on Context#resume
+- Fixed several cases of seg faults when accessing dyna_vars structure.
+
+0.7.2
+- Fixed Context#resume (a thread should be waked up only when it was running when it was suspended).
+- When handling post-mortem exception, all threads must be suspended.
+
+0.7.1
+- Fixed 'delete' command
+
+0.7
+- Eliminated explicit Frame object. Use Context.frame_[binding,file,line] instead.
+- Fixed help command.
+- Renamed Debugger.keep_frame_info to Debugger.keep_frame_binding
+- 'eval' command is available, even when keep_frame_binding is not used.
+- New 'set' command is available.
+
+0.6.2
+- Added thread lookup cache.
+- Control thread is always started by rdebug script.
+- Ability to specify negative frame number to frame commands. Patch from R. Bernstein.
+
+0.6.1
+- Another performance optimization.
+
+0.6
+- Added option to exclude collecting of frame bindings.
+- Several performance optimizations.
+
+0.5.4
+- Added -x/--trace option to rdebug script. Patch from R. Bernstein.
+- Removed a live thread reference from the context's structure avoiding memory leakage.
+
+0.5.3
+- Added Module#post_mortem_method method, which wraps any method with Debugger.post_mortem block.
+- Added breakpoint id, which is not dependent on the breakpoint position in Debugger.breakpoints array.
+
+0.5.2
+- Fixes interoperability problems with rspec.
+- Made 'exit' as an alias to 'quit'
+- Added 'restart' command. Patch from R. Bernstein.
+
+0.5.1
+- Bugfixes.
+
+0.5
+- Added post-mortem debugging
+- Added 'irb' command.
+
+0.4.5
+- Fixed debug_method when applied to setter.
+- Added 'reload' command which can be used to reload source code in case it's been changed.
+- Added Debugger.reload_source_on_change option (true, by default) which controls whether ruby-debug should keep
+  track of the source files modification times and reload them if they've been changed.
+
+0.4.4
+- Renamed Context#set_suspend and Context#clear_suspend methods to Context#suspend and Context#resume respectively.
+- Context#resume method not only clears suspend flag, but also resumes the thread execution.
+- Bugfixes.
+
+0.4.3
+- Added Debugger.skip method which allows escaping a block from the debugger reach.
+- Bugfixes.
+
+0.4.2
+- Module#deubg_method added.
+- Added rdoc.
+- Bugfixes.
+
+0.4.1
+- New binding_n method for Kernel module.
+- Bugfixes.
+
+0.4 
+- Debugger.start method takes a block. If a block is specified, this method starts debugger, yields to the block
+  and stops debugger at the end.
+- 'tm[ate]' command accepts a frame number now.
+- 'list' command accepts on/off parameter which controls whether listing will be displayed on every stop.
+- 'eval on/off' controls the evaluation of unknown command.
+- Debugger reads readline history file .rdebug_hist at startup and saves it at exit.
+- 'sa[ve] <file>' command can be used to save current breackpoints and catchpoint if any
+- 'sc[ript] <file>' command can be used to run script file. Script files can contain only control commands.
+- rdebug script accepts '--script FILE' parameter.
+- thread commands are available for the control port.
+
+0.3 (2006-08-07)
+- Renamed Debugger.start_server to Debugger.start_remote.
+- Debugger.start_remote activates debugger by calling Debugger.start.
+- Debugger.start_remote starts a control thread which listen on port 8990 and accepts control 
+  commands, such as adding/deleting breakpoints, assigning catchpoint, etc. (Useful for GUI integration)
+- New Debugger.wait_connection option. When it's true, Debugger.start_remote waits until
+  a remote connection is made.
+- New Debugger.stop_on_connect option. When a remote connection is established, debugger
+  stops the main thread (Thread.main).
+- 'interrupt' command is available for the control thread.
+
+0.2.1 (2006-07-29)
+- 'f[rame] nn' command selects a numbered frame. Frame numbers can be obtained by running frame 
+  command without parameters.
+- 'l[ist] =' show code in the context of the current line.
+- 'tm[ate]' opens the current file in TextMate. Available only on Mac OSX. 
+
+0.2 (2006-07-17)
+- Added the remote debugging. It should be activated by calling Debugger#start_server method.
+- CHANGED: In order to activate the debugger, it's not enough to require 'ruby-debug'. 
+  Debugger#start method must be called explicitly.
+- Debugger used to evaluate anything you enter as long as it's not a command. Starting from
+  this version the 'eval' command must be used to evaluate an expression.
+
+0.1.5 (2006-07-13)
+- Now the check for a  breakpoint uses base filename of the source file.
+- Removed compilation warnings when compiling with -Wall
+
+0.1.4 (2006-07-12)
+- Remembers the previous command. Invoke it by typing a carriage return
+  at the command prompt.
+
+0.1.3 (2006-07-11)
+- Conditional breakpoints
+- Bugfixes
+
+0.1.2 (2006-07-16)
+========================
+
+- Initial release.

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/README

@@ -1,40 +1,133 @@
-= ruby-debug-base for JRuby
+= ruby-debug
 
 == 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.
+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
 
-(j)ruby-debug-base is available as a RubyGem. Unfortunately it is still not
-installable remotely. But installation is easy enough:
+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.)
 
-- manually download the ruby-debug-base-0.10.3-java.gem to local directory from
-  here: http://rubyforge.org/frs/?group_id=3085 
+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:
 
-- install the Gem into your JRuby Gem repository:
+  sh ./configure
+  make
+  make test # optional, but a good idea
+  sudo make install
 
-   jruby -S gem install ruby-debug-base-0.10.3-java.gem
 
-- now install ruby-debug with:
+==== Install on MS Windows
 
-   jruby -S gem install --ignore-dependencies ruby-debug 
+Compiling under cygwin or mingw works like it does on Unix. 
 
-See also: http://wiki.jruby.org/wiki/Using_the_JRuby_Debugger
+* Have Microsoft Visual C++ 6.0 (VC6) installed - exactly that version.
 
-== Installation of trunk version
+* Set the appropriate environment variables.
 
-Handy for developers or users living on the cutting-edge.
+* run `nmake'.
 
-$ cd ~/tmp
-$ svn co svn://rubyforge.org/var/svn/debug-commons/jruby-debug/trunk jruby-debug
-$ cd jruby-debug
-$ rake gem
-$ jruby -S gem install -l pkg/ruby-debug-base-0.10.3-java.gem 
-$ jruby -S gem install columnize
-$ jruby -S gem install -r ruby-debug -v 0.10.3 --ignore-dependencies
+* 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.
+
+
+
+= 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
 
@@ -58,4 +151,3 @@ For more information see: http://bashdb.sourceforge.net/ruby-debug.html
 == License
 
 See MIT-LICENSE for license information.
-