rbx-trepanning 0.0.3-universal-rubinius-1.2 → 0.0.4-universal-rubinius-1.2

data/processor/command/backtrace.rb

@@ -4,32 +4,63 @@ require_relative './base/cmd'
 class Trepan::Command::BacktraceCommand < Trepan::Command
   ALIASES      = %w(bt where)
   CATEGORY     = 'stack'
+  MAX_ARGS     = 2 # Need at most this many
   NAME         = File.basename(__FILE__, '.rb')
   HELP = <<-HELP
-Show the call stack as a simple list.
+#{NAME} [full] [COUNT]
 
-Passing "-v" will also show the values of all locals variables
-in each frame.
+Print a backtrace of all stack frames, or innermost COUNT frames.  Use
+of the 'full' qualifier also prints the values of the local variables.
+
+Passing "full" will also show the values of all locals variables in
+each frame.
+
+Normally outer frames which constitute debugger overhead are hidden
+from view. However if a count is given and it runs into those hidden
+frames, they will be shown.
+
+Examples:
+
+#{NAME}  
+#{NAME} full   # show 
+#{NAME} 2 
+#{NAME} 3 full  
+#{NAME} full 3 # same as above
+#{NAME} 1000   # probably will show any outer hidden frames
+
+See also 'set hidelevel'.
       HELP
   NEED_STACK   = true
   SHORT_HELP   =  'Show the current call stack'
   
   def run(args)
-    arg_str = args[1..-1].join(' ')
-    verbose = (arg_str =~ /-v/)
-
-    count = 
-      if m = /(\d+)/.match(arg_str)
-        m[1].to_i
-      else
-        proc.stack_size
+    verbose_ary, count_ary = args[1..-1].partition {|item| item =~ /full/i}
+    verbose = !verbose_ary.empty?
+
+    if count_ary.size > 1
+      errmsg "Expecting only at most one parameter other than 'full'"
+      return
     end
     
-    msg "Backtrace:"
+    if 1 == count_ary.size
+      begin
+        count = Integer(count_ary[0])
+      rescue
+        errmsg "Expecting count to be an integer; got #{count_ary[0]}"
+        return
+      end
+    elsif 0 == count_ary.size
+      count = proc.stack_size
+    else
+      errmsg "Wrong number of parameters. Expecting at most 2."
+      return
+    end
     
     @proc.dbgr.each_frame(@proc.top_frame) do |frame|
-      return if count and frame.number >= count
-
+      if count and frame.number >= count
+        msg "(More stack frames follow...)" if count != proc.stack_size
+        return 
+      end
 
       prefix = (frame == @proc.frame) ? '-->' : '   '
       msg "%s #%d %s" % [prefix, frame.number, 
@@ -43,4 +74,3 @@ in each frame.
     end
   end
 end
-

data/processor/command/base/cmd.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>
 # Base class of all commands. Code common to all commands is here.
 # Note: don't end classname with Command (capital C) since main
 # will think this a command name like QuitCommand 
@@ -47,21 +47,21 @@ class Trepan
       @proc.confirm(message, default)
     end
 
-    def errmsg(message)
-      @proc.errmsg(message)
+    def errmsg(message, opts={})
+      @proc.errmsg(message, opts)
     end
 
     def obj_const(obj, name)
       obj.class.const_get(name) 
     end
 
-    def msg(message)
-      @proc.msg(message)
+    def msg(message, opts={})
+      @proc.msg(message, opts)
     end
 
     # Convenience short-hand for @dbgr.intf[-1].msg_nocr
     def msg_nocr(msg)
-      @proc.msg_nocr(msg)
+      @proc.msg_nocr(msg, opts={})
     end
 
     def my_const(name)
@@ -87,6 +87,10 @@ class Trepan
       raise RuntimeError, 'You need to define this method elsewhere'
     end
 
+    def section(message, opts={})
+      @proc.section(message, opts)
+    end
+
     def settings
       @proc.settings
     end

data/processor/command/base/subcmd.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.
 #
 # Note: don't end classname with Command (capital C) since main
@@ -194,6 +194,18 @@ class Trepan
 
 end
 
+module Trepanning
+  module Subcommand
+    module_function
+    def set_name_prefix(__file__, klass)
+      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}))
+    end
+  end
+end
+
 if __FILE__ == $0
   # Demo it.
   require_relative '../../mock'
@@ -210,4 +222,7 @@ if __FILE__ == $0
   # p subcmd.settings
   # p subcmd.show_onoff(subcmd.settings[:autoeval])
   # subcmd.run_set_int('', 'Just a test')
+  class Trepan::Subcommand::Foo < Trepan::Subcommand
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+  end
 end

data/processor/command/complete.rb

@@ -0,0 +1,47 @@
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative 'base/cmd'
+class Trepan::Command::CompleteCommand < Trepan::Command
+
+  unless defined?(HELP)
+    HELP = 
+"complete COMMAND-PREFIX
+
+List the completions for the rest of the line as a command.
+
+NOTE: For now we just handle completion of the first token.
+"
+    CATEGORY      = 'support'
+    NAME          = File.basename(__FILE__, '.rb')
+    NEED_STACK    = false
+    SHORT_HELP    = 'List the completions for the rest of the line as a command'
+  end
+
+  # This method runs the command
+  def run(args) # :nodoc
+    if args.size == 2
+      cmd_matches = @proc.commands.keys.select do |cmd|
+        cmd.start_with?(args[1])
+      end
+      alias_matches = @proc.aliases.keys.select do |cmd|
+        cmd.start_with?(args[1]) && !cmd_matches.member?(@proc.aliases[cmd])
+      end
+      (cmd_matches+alias_matches).sort.each do |match|
+        msg match
+      end
+    else # FIXME: handle more complex completions
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+  %w(d b bt).each do |prefix|
+    cmd.run [cmd.name, prefix]
+    puts '=' * 40
+  end
+  cmd.run %w(#{cmd.name} fdafsasfda)
+  puts '=' * 40
+end

data/processor/command/continue.rb

@@ -5,20 +5,21 @@ require_relative '../stepping'
 class Trepan::Command::ContinueCommand < Trepan::Command
   NAME         = File.basename(__FILE__, '.rb')
   HELP         = <<-HELP
-#{NAME} [breakpoint position]
+#{NAME} [breakpoint-position]
 
 Leave the debugger loop and continue execution. Subsequent entry to
 the debugger however may occur via breakpoints or explicit calls, or
 exceptions.
 
-If a parameter is given, a temporary breakpoint is set at that position
+If a parameter is given, a one-time breakpoint is set at that position
 before continuing. 
 
 Examples:
    #{NAME}
    #{NAME} 10    # continue to line 10
+   #{NAME} Array#map # beginning of next Array#map call
 
-See also 'step', 'next', and 'nexti' commands.
+See also 'step', 'next', 'finish', and 'nexti' commands.
       HELP
   ALIASES      = %w(c cont)
   CATEGORY     = 'running'

data/processor/command/directory.rb

@@ -9,6 +9,8 @@ class Trepan::Command::DirectoryCommand < Trepan::Command
     MAX_ARGS     = 1  # Need at most this many
     NAME         = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
+#{NAME} [DIR]
+
 Add directory DIR to beginning of search path for source files.
 DIR can also be $cwd for the current working directory, or $cdir for the
 directory in which the debugged file start.
@@ -16,7 +18,12 @@ With no argument, reset the search path to $cdir:$cwd, the default.
 
 This command may be useful for debugging into Rubinius methods such as
 kernel/common/module.rb if have the source code somewhere.
+
+Examples:
+   #{NAME} ~/.rvm/src/rbx-head  # Adds an rvm-like directory to path
+   #{NAME} # reset to $cdir:$cwd
       HELP
+
     SHORT_HELP  = 
       'Add directory DIR to beginning of search path for source files'
   end
@@ -24,7 +31,8 @@ kernel/common/module.rb if have the source code somewhere.
   # This method runs the command
   def run(args) # :nodoc
     if args.size > 1
-      settings[:directory] = "#{args[1]}:#{settings[:directory]}"
+      path = File.expand_path(args[1])
+      settings[:directory] = "#{path}:#{settings[:directory]}"
       msg "Source directories searched: #{settings[:directory]}"
     else
       if confirm('Reintialize source path to empty?', false)

data/processor/command/disassemble.rb

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 require_relative './base/cmd'
 require_relative '../../app/iseq'
@@ -32,6 +34,8 @@ Examples:
     lines = cm.lines
     next_line_ip = 0
     next_i = 1
+    prefixes = []
+    disasm = ''
     cm.decode.each do |insn|
       show_line = 
         if insn.ip >= next_line_ip
@@ -43,8 +47,8 @@ Examples:
           false
         end
           
-      prefix = Trepanning::ISeq::disasm_prefix(insn.ip, frame_ip, cm)
-      str = "#{prefix} #{insn}"
+      prefixes << Trepan::ISeq::disasm_prefix(insn.ip, frame_ip, cm)
+      str = insn.to_s
       if show_line
         str += 
           if insn.instance_variable_get('@comment')
@@ -56,7 +60,20 @@ Examples:
           end
         str += "# line: #{line_no}"  
       end
-      msg str
+      disasm += "#{str}\n"
+    end
+
+    # FIXME DRY with ../disassemble.rb
+    if settings[:highlight]
+      require_relative '../../app/rbx-llvm'
+      @llvm_highlighter = CodeRay::Duo[:llvm, :term]
+      # llvm_scanner = CodeRay.scanner :llvm
+      # p llvm_scanner.tokenize(disasm)
+      disasm = @llvm_highlighter.encode(disasm)
+    end
+      
+    disasm.split("\n").each_with_index do |inst, i|
+      msg ("#{prefixes[i]} #{inst}", :unlimited => true)
     end
   end
 
@@ -65,14 +82,12 @@ Examples:
     if 1 == args.size
       @proc.show_bytecode
     elsif 'all' == args[1]
-      # FIXME: first msg is a section command.
-      msg "Bytecode for #{@proc.frame.vm_location.describe}"
+      section "Bytecode for #{@proc.frame.vm_location.describe}"
       disassemble_method(current_method)
     else
       cm = @proc.parse_method(args[1])
       if cm
-        # FIXME: first msg is a section command.
-        msg "Bytecode for method #{args[1]}"
+        section "Bytecode for method #{args[1]}"
         disassemble_method(cm.executable)
       else
         errmsg "Method #{args[1]} not found"

data/processor/command/display.rb

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative 'base/cmd'
+
+class Trepan::Command::DisplayCommand < Trepan::Command
+
+  unless defined?(HELP)
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{name} [format] EXP
+ 
+Print value of expression EXP each time the program stops.  FMT may be
+used before EXP and may be one of 'c' for char, 'x' for hex, 'o' for
+octal, 'f' for float or 's' for string.
+
+For now, display expressions are only evaluated when in the same
+instruction sequence as the frame that was in effect when the display
+expression was set.  This is a departure from gdb and we may allow for
+more flexibility in the future to specify whether this should be the
+case or not.
+
+With no argument, evaluate and display all currently requested
+auto-display expressions.  Use "undisplay" to cancel display
+requests previously made.
+    HELP
+    
+    CATEGORY      = 'data'
+    NEED_STACK    = false
+    SHORT_HELP    = 'Display expressions when entering debugger'
+  end
+  
+  def run(args)
+
+    if args.size == 1
+      # Display anything active
+      @proc.run_eval_display
+    else
+      if %w(/c /x /o /f /s).member?(args[1])
+        if 2 == args.size
+          errmsg("Expecting an expression after the format")
+          return
+        end
+        format = args[1]
+        expr   = args[2..-1].join(' ')
+      else
+        format = nil
+        expr = args[1..-1].join(' ')
+      end
+
+      dp = @proc.displays.add(@proc.frame, expr, format)
+      unless dp
+        errmsg('Error evaluating "%s" in the current frame' % expr)
+        return
+      end
+      msg(dp.to_s(@proc.frame))
+      @proc.cmdloop_prehooks.insert_if_new(5, *@proc.display_hook)
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+
+  def run_cmd(cmd, args)
+    cmd.run(args)
+    puts '==' * 10
+  end
+
+  # run_cmd(cmd, [cmd.name])
+  # run_cmd(cmd, [cmd.name, '/x', '10'])
+  # run_cmd(cmd, [cmd.name, 'd'])
+  # run_cmd(cmd, [cmd.name])
+  e = 5
+  vm_locations  = Rubinius::VM.backtrace(0, true)
+  cmd.proc.instance_variable_set('@frame ',
+                                 Trepan::Frame.new(self, 0, vm_locations[0]))
+
+  run_cmd(cmd, [cmd.name, 'e'])
+end

data/processor/command/eval.rb

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 require_relative './base/cmd'
 
@@ -16,7 +18,7 @@ next to the inspect output of the value.
   NEED_STACK    = true
   SHORT_HELP    = 'Run code in the current context'
   def run(args)
-    @proc.debug_eval(@proc.cmd_argstr, @proc.settings[:maxstring])
+    @proc.debug_eval(@proc.cmd_argstr, settings[:maxstring])
   end
 end
 

data/processor/command/exit.rb

@@ -44,6 +44,10 @@ See also "kill".'
       return
     end
     exitrc = (args.size > 1) ? exitrc = Integer(args[1]) rescue 0 : 0
+
+    # FIXME: funnel to sort of more general finalize routine
+    @proc.dbgr.intf[-1].close
+
     # No graceful way to stop threads...
     # A little harsh, but for now let's go with this.
     exit! exitrc

data/processor/command/help.rb

@@ -1,11 +1,12 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 require_relative 'base/cmd'
 class Trepan::Command::HelpCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-"help [command [subcommand]|expression]
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} [command [subcommand]|expression]
 
 Without argument, print the list of available debugger commands.
 
@@ -22,8 +23,7 @@ subcommand. For example 'help info line' give help about the
 info line command.
 
 See also 'examine' and 'whatis'.
-"
-
+    HELP
 
     ALIASES       = %w(?)
     CATEGORIES    = {
@@ -36,20 +36,21 @@ See also 'examine' and 'whatis'.
     'stack'       => 'Examining the call stack'
     }
     CATEGORY      = 'support'
-    NAME          = File.basename(__FILE__, '.rb')
     NEED_STACK    = false
     SHORT_HELP    = 'Print commands or give help for command(s)'
   end
 
   # List the command categories and a short description of each.
   def list_categories
-    msg("Classes of commands:")
+    section 'Classes of commands:'
     CATEGORIES.keys.sort.each do |cat|
       msg("%-13s -- %s" % [cat, CATEGORIES[cat]])
     end
     final_msg = '
 Type "help" followed by a class name for a list of commands in that class.
+Type "help syntax" for information on debugger command syntax.
 Type "help *" for the list of all commands.
+Type "help all" 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.
@@ -62,8 +63,14 @@ Type "help" followed by command name for full documentation.
     if args.size > 1
       cmd_name = args[1]
       if cmd_name == '*'
-        msg("All command names:")
+        section 'All command names:'
         msg columnize_commands(@proc.commands.keys.sort)
+      elsif cmd_name =~ /^syntax$/i
+        show_command_syntax
+      elsif cmd_name =~ /^all$/i
+        CATEGORIES.sort.each do |category|
+          show_category(category[0], [])
+        end
       elsif CATEGORIES.member?(cmd_name)
         show_category(args[1], args[2..-1])
       elsif @proc.commands.member?(cmd_name) or @proc.aliases.member?(cmd_name)
@@ -84,42 +91,87 @@ Type "help" followed by command name for full documentation.
             msg "Aliases: #{cmd_obj.class.const_get(:ALIASES).join(', ')}"
           end
         end
-      else 
+      else
         matches = @proc.commands.keys.grep(/^#{cmd_name}/).sort rescue []
         if matches.empty?
           errmsg("No commands found matching /^#{cmd_name}/. Try \"help\".")
         else
-          msg("Command names matching /^#{cmd_name}/:")
+          section "Command names matching /^#{cmd_name}/:"
           msg columnize_commands(matches.sort)
         end
       end
     else
       list_categories
     end
-    return false  # Don't break out of cmd loop
   end
 
   # Show short help for all commands in `category'.
   def show_category(category, args)
       
     if args.size == 1 && args[0] == '*'
-      msg("Commands in class %s:" % category)
+      section "Commands in class %s:" % category
       
       cmds = @proc.commands.keys.select do |cmd_name|
         category == @proc.commands[cmd_name].category
       end.sort
-
       width = settings[:maxwidth]
       return columnize_commands(cmds)
     end
         
-    msg("%s." % CATEGORIES[category])
-    msg("List of commands:\n")
+    msg('')
+    section "Command class: %s" % category
+    msg('')
     @proc.commands.keys.sort.each do |name|
       next if category != @proc.commands[name].category
       msg("%-13s -- %s" % [name, @proc.commands[name].short_help])
     end
   end
+
+  def show_command_syntax
+    section "Debugger command syntax"
+    msg <<-EOS
+Command command syntax is very simple-minded. 
+
+If a line starts with #, the command is ignored. 
+If a line starts with !, the line is eval'd. 
+
+If the command you want eval'd uses the Ruby ! initally, add that
+after the first !.
+
+Commands are split at whereever ;; appears. This process disregards
+any quotes or other symbols that have meaning in Ruby. The strings
+after the leading command string are put back on a command queue. 
+
+Within a single command, tokens are then white-space split. Again,
+this process disregards quotes or symbols that have meaning in Ruby.
+
+The first token is then looked up in the debugger command table and
+then the debugger alias table. If a match is found the command name
+and arguments are dispatched to the command object that process the
+command.
+
+If the command is not found and "auto eval" is set on, then the
+command is eval'd in the context that the program is currently stopped
+at. If "auto eval" is not set on, then we display an error message
+that the entered string is "undefined".
+
+If you want irb-like command-processing, it's possible to go into an
+irb shell with the "irb" command. It is also possible to arrange going
+into an irb shell every time you enter the debugger.
+
+Examples:
+
+# This line does nothing. It is a comment
+s    # by default, this is an alias for the "step" command
+!s   # shows the value of variable step. 
+!!s  # Evaluates !s (or "not s"). The first ! is indicates evaluate.
+info program;; list # Runs two commands "info program" and "list"
+pr  "hi ;;-)"  # Syntax error since ;; splits the line and " is not closed.
+!puts "hi ;;-)" # One way to do the above.
+
+See also "alias", "irb", "set auto eval", and "set auto irb".
+    EOS
+  end
 end
 
 if __FILE__ == $0
@@ -129,16 +181,15 @@ if __FILE__ == $0
 
   cmd.run %W(#{cmd.name} help)
   puts '=' * 40
-  cmd.run %w(#{cmd.name} *)
+  cmd.run %W(#{cmd.name} *)
   puts '=' * 40
-  cmd.run %w(#{cmd.name} fdafsasfda)
+  cmd.run %W(#{cmd.name} fdafsasfda)
   puts '=' * 40
   cmd.run [cmd.name]
   puts '=' * 40
   cmd.run %W(#{cmd.name} support)
   puts '=' * 40
   cmd.run %W(#{cmd.name} support *)
-
   puts '=' * 40
   cmd.run %W(#{cmd.name} s.*)
   puts '=' * 40

data/processor/command/info_subcmd/breakpoints.rb

@@ -1,9 +1,12 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 require_relative '../base/subcmd'
 
 class Trepan::Subcommand::InfoBreakpoints < Trepan::Subcommand
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP         = <<-EOH
-info breakpoints [num1 ...] [verbose]
+#{PREFIX.join(' ')} [num1 ...] [verbose]
 
 Show status of user-settable breakpoints. If no breakpoint numbers are
 given, the show all breakpoints. Otherwise only those breakpoints
@@ -18,15 +21,9 @@ The "enb" column indicates whether the breakpoint is enabled.
 The "Where" column indicates where the breakpoint is located.
 EOH
   MIN_ABBREV   = 'br'.size
-  NAME         = File.basename(__FILE__, '.rb')
-  PREFIX       = %w(info breakpoints)
   SHORT_HELP   = 'Status of user-settable breakpoints'
   
   def run(args)
-    # FIXME: Originally was 
-    #   section "Breakpoints"
-    # Add section? 
-
     show_all = 
       if args.size > 2
         opts = {
@@ -46,10 +43,11 @@ EOH
       msg('No breakpoints.')
     else
       # There's at least one
+      section "Num  Breakpoint"
       bpmgr.list.each do |bp|
         msg "%3d: %s" % [bp.id, bp.describe]
       end
-      msg('Deferred breakpoints...')
+      section 'Deferred breakpoints...'
       @proc.dbgr.deferred_breakpoints.each_with_index do |bp, i|
         if bp
           msg "%3d: %s" % [i+1, bp.describe]