rbx-trepanning 0.0.6-universal-rubinius-1.2 → 0.0.7-universal-rubinius-1.2

data/app/options.rb

@@ -9,7 +9,7 @@ class Trepan
   require 'rubygems'; require 'require_relative'
   require_relative 'default'
 
-  Trepan::VERSION = '0.0.6'
+  Trepan::VERSION = '0.0.7'
   Trepan::PROGRAM = 'trepanx'
 
   def self.show_version
@@ -32,7 +32,7 @@ class Trepan
     OptionParser.new do |opts|
       opts.banner = <<EOB
 #{show_version}
-Usage: #{PROGRAM} [options] <script.rb> [-- <script.rb parameters>]
+Usage: #{PROGRAM} [options] [[--] <script.rb> <script.rb parameters>]
 EOB
       opts.on('--client',
               "Connect to out-of-process program") do

data/app/run.rb

@@ -4,7 +4,7 @@ require 'rbconfig'
 require 'rubygems'; require 'require_relative'
 module Trepanning
 
-  :module_function # All functions below are easily publically accessible
+  module_function # All functions below are easily publically accessible
 
   # Given a Ruby interpreter and program we are to debug, debug it.
   # The caller must ensure that ARGV is set up to remove any debugger
@@ -47,7 +47,10 @@ module Trepanning
       :skip_loader => true
     }.merge(start_opts)
     dbgr.start(start_opts)
-    Kernel::load program_to_debug
+    begin
+      Kernel::load program_to_debug
+    rescue Interrupt
+    end
 
     # The dance we have to undo to restore $0 and undo the mess created
     # above.
@@ -59,7 +62,6 @@ module Trepanning
   def ruby_path
     File.join(%w(bindir RUBY_INSTALL_NAME).map{|k| RbConfig::CONFIG[k]})
   end
-  module_function :ruby_path
 
   # Do a shell-like path lookup for prog_script and return the results.
   # If we can't find anything return prog_script.

data/bin/.gitignore

@@ -0,0 +1,2 @@
+/*~
+/*.rbc

data/data/.gitignore

@@ -0,0 +1,2 @@
+/*~
+/*.rbc

data/doc/.gitignore

@@ -0,0 +1 @@
+/*~

data/doc/debugger.html

@@ -0,0 +1,108 @@
+---
+title: Debugger
+---
+
+Debugger
+========
+
+Trepanning source-level debugger 
+
+Invoking in Code
+----------------
+
+The Rubinius debugger can be invoked from code by embedding a call to start
+the debugger
+
+Consider the following code in app.rb
+
+    class Toast
+      attr_accessor :setting
+      def initialize
+        require 'rubygems'
+        require 'trepanning'
+        Trepan.start ## See Note 1 below.
+        @setting = :brown
+        @kind    = :rye
+      end
+    end
+
+    p Toast.new.setting
+
+Running the code in Rubinius would produce the following:
+
+    $ rbx app.rb
+
+    | Breakpoint: Toast#initialize at tmp/toast.rb:5
+    | 5:     Trepan.start ## See Note 1 below.
+    (trepanx): help
+
+    Classes of commands:
+    breakpoints   -- Making the program stop at certain points
+    data          -- Examining data
+    files         -- Specifying and examining files
+    running       -- Running the program
+    stack         -- Examining the call stack
+    status        -- Status inquiries
+    support       -- Support facilities
+
+    Type "help" followed by a class name for a list of commands in that class.
+    Type "help *" for the list of all commands.
+    Type "help REGEXP" for the list of commands matching /^#{REGEXP}/
+    Type "help CLASS *" for the list of all commands in class CLASS.
+    Type "help" followed by command name for full documentation.
+
+    (trepanx): help *
+    All command names:
+      alias        delete         exit     kill     restart    step   
+      backtrace    disassemble    frame    next     set        tbreak 
+      break        down           help     nexti    show       unalias
+      continue     eval           info     ps       source     up     
+    (trepanx):  bt
+    Backtrace:
+       0 Toast#initialize at tmp/toast.rb:5
+       1 main.__script__ at tmp/toast.rb:11
+       2 Rubinius::CodeLoader#load_script(debug) at kernel/delta/codeloader.rb:67
+       3 Rubinius::CodeLoader.load_script(name) at kernel/delta/codeloader.rb:91
+       4 Rubinius::Loader#script at kernel/loader.rb:460
+       5 Rubinius::Loader#main at kernel/loader.rb:552
+       6 Rubinius::Loader.main at kernel/loader.rb:589
+       7 Object#__script__ at kernel/loader.rb:601
+    (trepanx):  n
+
+    | Breakpoint: Toast#initialize at app.rb:6 (16)
+    | 6:     @setting = :brown
+    (trepanx):  n
+
+    | Breakpoint: Toast#initialize at app.rb:7 (21)
+    | 7:     @kind = :rye
+    (trepanx):  eval @setting = :light_brown  ## See Note 2 below.
+    $d0 = :light_brown
+    (trepanx):  c  # See Note 3.
+    :light_brown   # output from running program
+
+Help for the debugger commands is available by typing `help` when in the
+debugger. 
+
+** Note 1.
+Or if you haven't mucked with ARGV, Dir.pwd, and $0 use:
+Trepan.start(:set_restart => true).  This tells the debugger to
+capture this information so you can easily restart your program if you
+need to.
+
+** Note 2. 
+If you run "set autoeval on" (actually this is on by default), then
+unrecognized commands are automatically evaluated. So the "eval" is
+not needed. However if this confuses you "set autoeval off".  Another
+way to explicitly evaluate commands is to start the line with !.
+
+** Note 3.
+
+To quit execution, you can use exit which prompts for confimation or
+q! which won't prompt. You can supply an exit code to return to the
+OS. A related command is "kill" which sends a signal to the process,
+the default when none is supplied being "TERM". Finally there's
+"restart" which you would use if you had started with :set_restart =>
+true.
+
+
+More later....

data/interface/.gitignore

@@ -0,0 +1,2 @@
+/*.rbc
+/*~

data/interface/user.rb

@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 
-# Interface when communicating with the user in the same process as
-# the debugged program.
+# Interface when communicating with the user.
 
 # Our local modules
 
@@ -33,8 +32,8 @@ class Trepan::UserInterface < Trepan::Interface
              else
                Trepan::UserInput.open(inp, {:readline => opts[:readline]})
              end
-    if Trepan::GNU_readline? && opts[:complete]
-      Readline.completion_proc = opts[:complete]
+    if Trepan::GNU_readline? && @opts[:complete]
+      Readline.completion_proc = @opts[:complete]
       read_history
     end
     at_exit { finalize }
@@ -102,7 +101,7 @@ class Trepan::UserInterface < Trepan::Interface
   end
 
   def finalize(last_wishes=nil)
-    # print exit annotation
+    # ?? print gdb-style exit annotation if annotate = 2?
     if Trepan::GNU_readline? && @history_save
       save_history 
     end
@@ -111,11 +110,13 @@ class Trepan::UserInterface < Trepan::Interface
 
   def interactive? ; @input.interactive? end
 
-  def read_command(prompt=''); readline(prompt) end
+  def read_command(prompt='')
+    readline(prompt) 
+  end
 
   def readline(prompt='')
     @output.flush
-    if @input.line_edit && @opts[:use_readline]
+    if @input.line_edit && @opts[:readline]
       @input.readline(prompt)
     else
       @output.write(prompt) if prompt and prompt.size > 0

data/io/.gitignore

@@ -0,0 +1,3 @@
+/*.rbc
+/*~
+

data/io/input.rb

@@ -21,7 +21,7 @@ class Trepan
       @input        = inp || STDIN
       @eof          = false
       @line_edit    = @opts[:line_edit]
-      @use_readline = opts[:readline]
+      @use_readline = @opts[:readline]
     end
 
     def closed?; @input.closed? end
@@ -30,7 +30,6 @@ class Trepan
     def interactive? 
       @input.respond_to?(:isatty) && @input.isatty
     end
-
     # Read a line of input. EOFError will be raised on EOF.  
     def readline(prompt='')
       raise EOFError if eof?
@@ -66,9 +65,15 @@ class Trepan
       end
 
       def finalize
-        if defined?(RbReadline) && !@@readline_finalized
-          RbReadline.rl_cleanup_after_signal()
-          RbReadline.rl_deprep_terminal()
+       if defined?(RbReadline) && !@@readline_finalized
+          begin 
+            RbReadline.rl_cleanup_after_signal()
+          rescue
+          end
+          begin 
+            RbReadline.rl_deprep_terminal()
+          rescue
+          end
           @@readline_finalized = true
         end
       end
@@ -79,7 +84,10 @@ end
 def Trepan::GNU_readline?
   begin
     return @use_readline unless @use_readline.nil?
-    @use_readline ||= require 'rb-readline.rb'
+    %w(rb-readline rb-readline.rb/readline).each do |gem_name|
+      @use_readline ||= require gem_name
+      break if @use_readline
+    end
     if @use_readline
       # Returns current line buffer
       def Readline.line_buffer
@@ -131,5 +139,3 @@ if __FILE__ == $0
     end
   end
 end
-
-

data/lib/.gitignore

@@ -0,0 +1,2 @@
+/*.rbc
+/*~

data/lib/trepanning.rb

@@ -1,10 +1,11 @@
+#!/usr/bin/env ruby
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'readline'
 require 'compiler/iseq'
 
 require 'rubygems'; require 'require_relative'
-require_relative '../app/complete'
+require_relative '../app/complete'       # command completion
 require_relative '../app/frame'
 require_relative '../app/util'           # get_dollar_0
 require_relative '../processor/main'
@@ -12,6 +13,7 @@ require_relative '../app/breakpoint'
 require_relative '../app/default'        # default debugger settings
 require_relative '../app/breakpoint'
 require_relative '../interface/user'     # user interface (includes I/O)
+require_relative '../interface/script'   # --command interface (includes I/O)
 require_relative '../interface/client'   # client interface (remote debugging)
 require_relative '../interface/server'   # server interface (remote debugging)
 require_relative '../io/null_output'
@@ -26,7 +28,6 @@ class Trepan
   attr_accessor :breakpoint   # Breakpoint. The current breakpoint we are
                               # stopped at or nil if none.
   attr_accessor :intf         # Array. The way the outside world
-                              # interfaces with us.  An array, so that
                               # interfaces with us.  An array, so that
                               # interfaces can be stacked.
   attr_accessor :restart_argv # How to restart us, empty or nil.
@@ -129,40 +130,24 @@ class Trepan
 
   # The method is called when we want to do debugger command completion
   # such as called from GNU Readline with <TAB>.
-  def completion_method(str, leading=Readline.line_buffer)
-    args =
-      if str.empty? && leading.end_with?(' ')
-        # A line ending with a blank means we want to get all completions
-        # of the *next* token, not the current token.
-        leading.split(' ').compact + ['']
-      else
-        # We split on a single blank rather than sequences of spaces
-        # because we need to keep the line exactly as it is except for the
-        # last token
-        leading.split(' ').compact
-      end
-    completion = @processor.complete(args)
+  def completion_method(last_token, leading=Readline.line_buffer)
+    completion = @processor.complete(leading, last_token)
     if 1 == completion.size 
-      last_token = completion[0].split[-1]
-      if  last_token == str
-        # If we were at the end of a complete token add a space so that
-        # the next time, we'll complete any context after that.
-        [str + ' ']
-      elsif str.end_with?(' ') && str.strip == last_token 
-        # There is nothing more to complete
-        []
-      elsif str.empty? && completion[0] == leading
-        # There is also nothing more to complete
-        []
+      completion_token = completion[0]
+      if last_token.end_with?(' ')
+        if last_token.rstrip == completion_token 
+          # There is nothing more to complete
+          []
+        else
+          []
+        end
       else
-        [last_token]
+        [completion_token]
       end
     else
       # We have multiple completions. Get the last token so that will
       # be presented as a list of completions.
-      completion.map do |cmd|
-        cmd.split[-1]
-      end
+      completion
     end
   end
 
@@ -244,6 +229,7 @@ class Trepan
   alias debugger start
 
   def stop(settings = {})
+    @processor.finalize
     Rubinius::VM.debug_channel = nil
   end
 
@@ -309,9 +295,15 @@ class Trepan
       if @breakpoint
         # Some breakpoints are frame specific. Check for this.  hit!
         # also removes the breakpoint if it was temporary and hit.
-        break if @breakpoint.hit!(@vm_locations.first.variables)
+        status = @breakpoint.hit!(@vm_locations.first.variables)
+        if status
+          break
+        elsif status.nil? 
+          # A permanent breakpoint. Check the condition.
+          break if @breakpoint.condition?(@current_frame.binding)
+        end
       else
-        @processor.step_bp.remove! if @processor.step_bp
+        @processor.remove_step_brkpt
         break
       end
     end

data/processor/.gitignore

@@ -0,0 +1,3 @@
+/*.rbc
+/*~
+

data/processor/Makefile

@@ -0,0 +1,7 @@
+# Whatever it is you want to do, it should be forwarded to the 
+# to top-level irectories
+PHONY=check
+check:
+
+%: 
+	$(MAKE) -C .. $@

data/processor/breakpoint.rb

@@ -19,6 +19,10 @@ class Trepan
       @brkpt  = nil
     end
 
+    def breakpoint_finalize
+      @brkpts.finalize
+    end
+
     def breakpoint?
       @brkpt = @dbgr.breakpoint
       return !!@brkpt && %w(tbrkpt brkpt).member?(@brkpt.event)

data/processor/command/.gitignore

@@ -0,0 +1,2 @@
+/*.rbc
+/*~

data/processor/command/backtrace.rb

@@ -33,6 +33,11 @@ See also 'set hidelevel'.
   NEED_STACK   = true
   SHORT_HELP   =  'Show the current call stack'
   
+  def complete(prefix)
+    @proc.frame_complete(prefix, nil)
+  end
+  
+  # This method runs the command
   def run(args)
     verbose_ary, count_ary = args[1..-1].partition {|item| item =~ /full/i}
     verbose = !verbose_ary.empty?

data/processor/command/base/.gitignore

@@ -0,0 +1,2 @@
+/*.rbc
+/*~

data/processor/command/base/subcmd.rb

@@ -202,7 +202,8 @@ module Trepanning
       dirname    = File.basename(File.dirname(File.expand_path(__file__)))
       name = File.basename(__file__, '.rb')
       klass.const_set('NAME', name)
-      klass.const_set('PREFIX', %W(#{dirname[0...-'_subcmd'.size]} #{name}))
+      prefix = klass.const_set('PREFIX', %W(#{dirname[0...-'_subcmd'.size]} #{name}))
+      klass.const_set('CMD', prefix.join(' '))
     end
   end
 end

data/processor/command/base/subsubcmd.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # A base class for debugger subcommands of subcommands.
 #
 # Note: don't end classname with Command (capital C as in SubCommand),
@@ -63,6 +63,7 @@ class Trepan
   end
 
   class SetBoolSubSubcommand < SubSubcommand
+    completion %w(on off)
     def run(args)
       run_set_bool(args)
     end
@@ -86,6 +87,27 @@ class Trepan
   end
 end
 
+module Trepanning
+  module SubSubcommand
+    module_function
+    def set_name_prefix(__file__, klass)
+      full_dirname = File.dirname(File.expand_path(__file__))
+      full_parent_dirname = File.expand_path(File.join(full_dirname, '..'))
+      dirname = File.basename(full_dirname)
+      parent_dirname = File.basename(full_parent_dirname)
+      name = File.basename(__file__, '.rb')
+      klass.const_set('NAME', name)
+
+      short_dirname = dirname[0...-'_subcmd'.size]
+      short_parent_dirname = parent_dirname[0...-'_subcmd'.size]
+      prefix = klass.const_set('PREFIX', %W(#{short_parent_dirname} 
+                                            #{short_dirname} #{name}))
+      klass.const_set('CMD', prefix.join(' '))
+    end
+  end
+end
+
+
 if __FILE__ == $0
   # Demo it.
   require_relative '../../mock'

data/processor/command/base/subsubmgr.rb

@@ -154,7 +154,8 @@ class Trepan::SubSubcommandMgr < Trepan::Subcommand
   end
 
   def complete_token_with_next(prefix)
-    Trepan::Complete.complete_token_with_next(@subcmds.subcmds, prefix)
+    Trepan::Complete.complete_token_with_next(@subcmds.subcmds, prefix,
+                                              self.prefix.join(''))
   end
 
   def run(args)

data/processor/command/complete.rb

@@ -18,7 +18,8 @@ List the completions for the rest of the line as a command.
 
   # This method runs the command
   def run(args) # :nodoc
-    @proc.complete(args[1..-1]).each do |match|
+    last_arg = @proc.cmd_argstr.end_with?(' ') ? '' : args[-1]
+    @proc.complete(@proc.cmd_argstr, last_arg).each do |match|
       msg match
     end
   end

data/processor/command/condition.rb

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative 'base/cmd'
+require_relative '../breakpoint'
+require_relative '../../app/breakpoint'
+require_relative '../../app/condition'
+
+class Trepan::Command::ConditionCommand < Trepan::Command
+
+  unless defined?(HELP)
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} BP_NUMBER CONDITION
+
+BP_NUMBER is a breakpoint number.  CONDITION is an expression which
+must evaluate to True before the breakpoint is honored.  If CONDITION
+is absent, any existing condition is removed; i.e., the breakpoint is
+made unconditional.
+
+Examples:
+   #{NAME} 5 x > 10  # Breakpoint 5 now has condition x > 10
+   #{NAME} 5         # Remove above condition
+    HELP
+
+    ALIASES       = %w(cond)
+    CATEGORY      = 'breakpoints'
+    MIN_ARGS      = 1
+    NEED_STACK    = false
+    SHORT_HELP    = 'Specify breakpoint number N to break only if COND is true'
+  end
+
+  include Trepan::Condition
+
+  def run(args)
+    bpnum = @proc.get_an_int(args[1])
+    bp = @proc.breakpoint_find(bpnum)
+    return unless bp
+    
+    if args.size > 2
+      condition = args[2..-1].join(' ')
+      return unless valid_condition?(condition)
+    else
+      condition = 'true'
+      msg('Breakpoint %d is now unconditional.' % bp.id)
+    end
+    bp.condition = condition
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+
+  cmd.run([cmd.name, '1'])
+  cmdproc = dbgr.processor
+  cmds = cmdproc.commands
+  break_cmd = cmds['break']
+  break_cmd.run([break_cmd.name, __LINE__.to_s])
+  cmd.run([cmd.name, '1', 'x' '>' '10'])
+  cmd.run([cmd.name, '1'])
+end

data/processor/command/down.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 require_relative 'up'
 
@@ -10,14 +10,14 @@ class Trepan::Command::DownCommand < Trepan::Command::UpCommand
   # Silence already initialized constant .. warnings
   old_verbose = $VERBOSE  
   $VERBOSE    = nil
-  HELP = 
-"d(own) [count]
+  HELP = <<-HELP
+#{NAME} [count]
 
 Move the current frame down in the stack trace (to a newer frame). 0
 is the most recent frame. If no count is given, move down 1.
 
 See also 'up' and 'frame'.
-"
+  HELP
 
   ALIASES       = %w(d)
   NAME          = File.basename(__FILE__, '.rb')

data/processor/command/eval.rb

@@ -5,8 +5,9 @@ require_relative './base/cmd'
 
 class Trepan::Command::EvalCommand < Trepan::Command
 
+  old_verbose = $VERBOSE  
+  $VERBOSE    = nil
   NAME          = File.basename(__FILE__, '.rb')
-  CATEGORY      = 'data'
   HELP    = <<-HELP
 #{NAME} [STRING]
 
@@ -17,23 +18,30 @@ may be used again easily. The name of the global variable is printed
 next to the inspect output of the value.
 
 If no string is given we run the string from the current source code
-about to be run
+about to be run. If the command ends ? (via an alias) and no string
+is given we will also strip off any leading 'if', 'while', 'elseif' or
+'until' in the string. 
 
 #{NAME} 1+2  # 3
 #{NAME} @v
 #{NAME}      # Run current source-code line
+#{NAME}?     # but strips off leading 'if', 'while', 'elsif' or 'until'
+             # from command 
 
 See also 'set autoeval'
       HELP
 
-  NAME          = File.basename(__FILE__, '.rb')
+  ALIASES       = %w(eval? ev? ev)
+  CATEGORY      = 'data'
   NEED_STACK    = true
   SHORT_HELP    = 'Run code in the current context'
+  $VERBOSE      = old_verbose 
+
   def run(args)
     if args.size == 1
-      loc = @proc.source_location_info
-      opts = {:reload_on_change => @proc.reload_on_change}
-      loc, junk, text = @proc.loc_and_text(loc, opts)
+      text  = @proc.current_source_text
+      text.gsub!(/^\s*(?:if|elsif|until|while)\s*/,'') if 
+        '?' == args[0][-1..-1] 
       msg "eval: #{text}"
     else
       text = @proc.cmd_argstr