rbx-trepanning 0.2.0-universal-rubinius-2.0

data/processor/command/unalias.rb

@@ -0,0 +1,49 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../command'
+require_relative '../../app/complete'
+
+class Trepan::Command::UnaliasCommand < Trepan::Command
+
+  unless defined?(HELP)
+    HELP = <<-HELP
+unalias ALIAS
+
+Remove alias ALIAS
+
+See also 'alias'.
+HELP
+
+    CATEGORY      = 'support'
+    MIN_ARGS      = 1
+    # MAX_ARGS      = 1  # Need at most this many
+    NAME          = File.basename(__FILE__, '.rb')
+    NEED_STACK    = true
+    SHORT_HELP    = 'Remove an alias'
+  end
+  
+  def complete(prefix)
+    Trepan::Complete.complete_token(@proc.aliases.keys, prefix)
+  end
+
+  # Run command. 
+  def run(args)
+    args[1..-1].each do |arg|
+      if @proc.aliases.member?(arg)
+        @proc.aliases.delete(arg)
+        msg "Alias for #{arg} removed."
+      else
+        msg "No alias found for #{arg}."
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+  cmd.run %w(cmd.name n)
+  cmd.run %w(cmd.name n)
+  cmd.run %w(cmd.name foo bar c)
+end

data/processor/command/undisplay.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../command'
+
+# undisplay display-number...
+class Trepan::Command::UndisplayCommand < Trepan::Command
+    
+  unless defined?(HELP)
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<EOH
+#{NAME} DISPLAY_NUMBER ...
+Cancel some expressions to be displayed when program stops.
+Arguments are the code numbers of the expressions to stop displaying.
+No argument means cancel all automatic-display expressions.
+"delete display" has the same effect as this command.
+Use "info display" to see current list of display numbers.
+EOH
+
+    CATEGORY      = 'data'
+    NEED_STACK    = false
+    SHORT_HELP    = 'Cancel some expressions to be displayed when program stops'
+  end
+
+  def complete(prefix)
+    @proc.displays.nums.map{|disp| disp.to_s}
+  end
+
+  def run(args)
+    
+    if args.size == 1
+      if confirm('Delete all displays?', false)
+        @proc.displays.clear
+        return
+      end
+    end
+    opts = {}
+    args[1..-1].each do |arg|
+      opts = {:msg_on_error => '%s must be a display number' % arg}
+      i = @proc.get_an_int(arg, opts)
+      if i 
+        unless @proc.displays.delete_index(i)
+          errmsg("No display number %d." % i)
+          return
+        end
+      end
+    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, %W(#{cmd.name} z))
+  run_cmd(cmd, %W(#{cmd.name} 1 10))
+end

data/processor/command/up.rb

@@ -0,0 +1,89 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../command'
+require_relative '../../app/util'
+
+# up command. Like 'down' but the direction (set by DIRECTION) is different.
+#
+# NOTE: The down command  subclasses this, so beware when changing! 
+class Trepan::Command::UpCommand < Trepan::Command
+
+  Trepan::Util.suppress_warnings {
+    NAME        = File.basename(__FILE__, '.rb')
+    HELP        = <<-HELP
+#{NAME} [count]
+
+Move the current frame up in the stack trace (to an older frame). 0 is
+the most recent frame. If no count is given, move up 1.
+
+See also 'down' and 'frame'.
+  HELP
+
+    ALIASES       = %w(u)
+    CATEGORY      = 'stack'
+    MAX_ARGS      = 1  # Need at most this many
+    NEED_STACK    = true
+    SHORT_HELP    = 'Move frame in the direction of the caller of the last-selected frame'
+  }
+
+  def complete(prefix)
+    @proc.frame_complete(prefix, @direction)
+  end
+  
+  def initialize(proc)
+    super
+    @direction = +1 # -1 for down.
+  end
+
+  # Run 'up' command.
+  def run(args)
+
+    # FIXME: move into @proc and test based on NEED_STACK.
+    if @proc.stack_size == 0
+      errmsg('No frames recorded.')
+      return false
+    end
+
+    if args.size == 1
+      # Form is: "up" which means "up 1"
+      count = 1
+    else
+      count_str = args[1]
+      name_or_id = args[1]
+      low, high = @proc.frame_low_high(@direction)
+      opts = {
+        :msg_on_error =>
+        "The '#{NAME}' command argument must eval to an integer. Got: %s" % count_str,
+        :min_value => low, :max_value => high
+      }
+      count = @proc.get_an_int(count_str, opts)
+      return false unless count
+    end
+    @proc.adjust_frame(@direction * count, false)
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+
+  # def sep ; puts '=' * 40 end
+  # cmd.run [cmd.name]
+  # %w(-1 0 1 -2).each do |count|
+  #   puts "#{cmd.name} #{count}"
+  #   cmd.run([cmd.name, count])
+  #   sep
+  # end
+  # def foo(cmd, cmd.name)
+  #   puts "#{cmd.name}"
+  #   cmd.run([cmd.name])
+  #   sep
+  #   %w(-2 -1).each do |count|
+  #     puts "#{cmd.name} #{count}"
+  #     cmd.run([cmd.name, count])
+  #     sep
+  #   end
+  # end
+  # foo(cmd, cmd.name)
+end

data/processor/command.rb

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-
+# 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 
+require 'rubygems'; require 'require_relative'
+require 'columnize'
+require_relative '../app/complete'
+
+class Trepan
+  class Command
+    attr_accessor :core, :proc
+
+    unless defined?(MIN_ARGS)
+      MIN_ARGS      = 0      # run()'s args array must be at least this many
+      MAX_ARGS      = nil    # run()'s args array must be at least this many
+      NEED_STACK    = false  # We'll say that commands which need a stack
+                             # to run have to declare that and those that
+                             # don't don't have to mention it.
+    end
+
+    def initialize(proc)
+      @name = my_const(:NAME)
+      @proc = proc
+    end
+
+    def category
+      my_const(:CATEGORY)
+    end
+
+    # List commands arranged in an aligned columns
+    def columnize_commands(commands)
+      width = settings[:maxwidth]
+      Columnize::columnize(commands, width, ' ' * 4, 
+                           true, true, ' ' * 2).chomp
+    end
+
+    def columnize_numbers(commands)
+      width = settings[:maxwidth]
+      Columnize::columnize(commands, width, ', ',
+                           false, false, ' ' * 2).chomp
+    end
+
+    # FIXME: probably there is a way to do the delegation to proc methods
+    # without having type it all out.
+
+    def confirm(message, default)
+      @proc.confirm(message, default)
+    end
+
+    def errmsg(message, opts={})
+      @proc.errmsg(message, opts)
+    end
+
+    def obj_const(obj, name)
+      obj.class.const_get(name) 
+    end
+
+    def msg(message, opts={})
+      @proc.msg(message, opts)
+    end
+
+    # Convenience short-hand for @dbgr.intf[-1].msg_nocr
+    def msg_nocr(msg, opts={})
+      @proc.msg_nocr(msg, opts)
+    end
+
+    def my_const(name)
+      # Set class constant SHORT_HELP to be the first line of HELP
+      # unless it has been defined in the class already.
+      # The below was the simplest way I could find to do this since
+      # we are the super class but want to set the subclass's constant.
+      # defined? didn't seem to work here.
+      c = self.class.constants
+      if c.member?('HELP') and !c.member?('SHORT_HELP')
+        short_help = self.class.const_get(:HELP).split("\n")[0].chomp('.')
+        self.class.const_set(:SHORT_HELP, short_help)
+      end
+      self.class.const_get(name)
+    end
+
+    def name
+      self.class.const_get(:NAME)
+    end
+
+    # The method that implements the debugger command.
+    def run(*args)
+      raise RuntimeError, 'You need to define this method elsewhere'
+    end
+
+    def section(message, opts={})
+      @proc.section(message, opts)
+    end
+
+    def settings
+      @proc.settings
+    end
+
+    def short_help
+      help_constant_sym = if self.class.constants.member?('SHORT_HELP') 
+                            :SHORT_HELP 
+                          else :HELP
+                          end
+      my_const(help_constant_sym)
+    end
+
+    # Define a method called 'complete' on the singleton class.
+    def self.completion(ary) 
+      self.send(:define_method, 
+                :complete, 
+                Proc.new {|prefix| 
+                  Trepan::Complete.complete_token(ary, prefix) })
+    end
+
+    # From reference debugger
+    def run_code(str)
+      @proc.dbgr.current_frame.run(str)
+    end
+
+    def current_method
+      @proc.frame.method
+    end
+
+    def current_frame
+      @proc.frame
+    end
+
+    def variables
+      @proc.variables
+    end
+
+    def listen(step=false)
+      @proc.listen(step)
+    end
+
+  end
+end
+if __FILE__ == $0
+  class Trepan
+    class CmdProcessor
+      def initialize(dbgr)
+      end
+      def confirm(message, default)
+        p ['confirm: ', message, default]
+      end
+      def errmsg(message, opts)
+        p ['err:', message, opts]
+      end
+      def msg(message, opts)
+        p [message, opts]
+      end
+      def msg_nocr(message, opts)
+        p ['nocr: ', message, opts]
+      end
+      def section(message, opts)
+        p ['section: ', message, opts]
+      end
+    end
+    class Command::Test < Trepan::Command
+      NAME = 'test'
+      CATEGORY = 'testcategory'
+      completion %w(a aa ab ba aac)
+    end
+  end
+  proc = Trepan::CmdProcessor.new(nil)
+  cmd = Trepan::Command::Test.new(proc)
+  %w(confirm errmsg msg msg_nocr section).each do |meth|
+    cmd.send(meth, 'test', nil)
+  end
+  p cmd.complete('aa')
+  cmd.instance_variable_set('@completions', %w(aardvark apple))
+  p cmd.complete('aa')
+end

data/processor/default.rb

@@ -0,0 +1,64 @@
+# Copyright (C) 2010-2011, 2013 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../app/default'
+require_relative 'virtual'
+class Trepan::CmdProcessor < Trepan::VirtualCmdProcessor
+
+  computed_displaywidth = (ENV['COLUMNS'] || '80').to_i
+  computed_displaywidth = 80 unless computed_displaywidth >= 10
+
+  DEFAULT_SETTINGS = {
+    :abbrev        => true,       # Allow abbreviations of debugger commands?
+    :autoeval      => true,       # Ruby eval non-debugger commands
+    :autoirb       => false,      # Go into IRB in debugger command loop
+    :autolist      => false,      # Run 'list' 
+    
+    :basename      => false,      # Show basename of filenames only
+    :confirm       => true,       # Confirm potentially dangerous operations?
+    :different     => 'nostack',  # stop *only* when  different position? 
+    
+    :debugdbgr     => false,      # Debugging the debugger
+    :debugexcept   => true,       # Internal debugging of command exceptions
+    :debugmacro    => false,      # debugging macros
+    :debugskip     => false,      # Internal debugging of step/next skipping
+    :directory     =>             # last-resort path-search for files
+                    '$rbx:$cdir:$cwd',  # that are not fully qualified.
+
+    :hidestack     => nil,        # Fixnum. How many hidden outer
+                                  # debugger stack frames to hide?
+                                  # nil or -1 means compute value. 0
+                                  # means hide none. Less than 0 means show
+                                  # all stack entries.
+    :hightlight    => false,      # Use terminal highlight? 
+    
+    :maxlist       => 10,         # Number of source lines to list 
+    :maxstack      => 10,         # backtrace limit
+    :maxstring     => 150,        # Strings which are larger than this
+                                  # will be truncated to this length when
+                                  # printed
+    :maxwidth       => computed_displaywidth,
+    :prompt         => 'trepanx', # core part of prompt. Additional info like
+                                  # debug nesting and thread name is fixed
+                                  # and added on.
+    :reload         => false,     # Reread source file if we determine
+                                  # it has changed?
+    :save_cmdfile  => nil,        # If set, debugger command file to be
+                                  # used on restart
+    :timer         => false,      # show elapsed time between events
+    :traceprint    => false,      # event tracing printing
+    :tracebuffer   => false,      # save events to a trace buffer.
+    :user_cmd_dir  => File.join(%W(#{Trepan::HOME_DIR} trepanx command)),
+                                  # User command directory
+
+    # Rubinius-specific user variables
+    :show_ip         => false,
+    :show_bytecode   => false,
+    
+    } unless defined?(CmdProcessor::DEFAULT_SETTINGS)
+end
+
+if __FILE__ == $0
+  # Show it:
+  require 'pp'
+  PP.pp(Trepan::CmdProcessor::DEFAULT_SETTINGS)
+end

data/processor/disassemble.rb

@@ -0,0 +1,59 @@
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../app/iseq'
+require_relative 'virtual'
+
+class Trepan::CmdProcessor < Trepan::VirtualCmdProcessor
+
+  def show_bytecode(line=@frame.vm_location.line, ip=@frame.next_ip)
+    meth = @frame.method
+    if 0 == line 
+      start, fin = Trepan::ISeq::ip_ranges_for_ip(@frame.method.lines, ip)[0]
+    else
+      start = meth.first_ip_on_line(line)
+      unless start
+        errmsg "Can't find bytecode for line #{line}"
+        return
+      end
+      fin = meth.first_ip_on_line(line+1)
+    end
+    
+    if !fin || fin == -1
+      fin = meth.iseq.size
+    end
+    
+    start += 1 if start == -1
+    suffix = 
+      if 0 == line 
+        "tail code before line #{Trepan::ISeq::tail_code_line(meth, ip)}"
+      else
+        "line #{line}"
+      end
+    section "Bytecode between #{start} and #{fin-1} for line #{suffix}"
+    
+    iseq_decoder = Rubinius::InstructionDecoder.new(meth.iseq)
+    partial = iseq_decoder.decode_between(start, fin)
+    
+    ip = start
+    
+    prefixes = []
+    disasm = partial.inject('') do |result, ins|
+      inst = Rubinius::CompiledMethod::Instruction.new(ins, meth, ip)
+      prefixes << Trepan::ISeq::disasm_prefix(ip, frame.next_ip, meth)
+      ip += ins.size
+      result += "#{inst}\n"
+    end
+    
+    # FIXME DRY with command/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
+end

data/processor/display.rb

@@ -0,0 +1,53 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../app/display'
+require_relative 'virtual'
+class Trepan
+  class CmdProcessor < VirtualCmdProcessor
+    attr_reader   :displays
+    
+    def display_initialize
+      @displays = DisplayMgr.new
+    end
+    
+    def display_find(num, show_errmsg = true)
+      if 0 == @displays.size 
+        errmsg('No display expressions set.') if show_errmsg
+        return nil
+      elsif num > @displays.max || num < 1
+        errmsg('Display number %d is out of range 1..%d' %
+               [num, @displays.max]) if show_errmsg
+        return nil
+      end
+      disp = @displays[num]
+      if disp
+        return disp
+      else
+        errmsg('Display number %d previously deleted.' %
+               num) if show_errmsg
+        return nil
+      end
+    end
+    
+    # Enable or disable a breakpoint given its breakpoint number.
+    def en_disable_display_by_number(num, do_enable=true)
+      disp = display_find(num)
+      return false unless disp
+      
+      enable_disable = do_enable ? 'en' : 'dis'
+      if disp.enabled? == do_enable
+        errmsg('Display %d previously %sabled.' % 
+               [num, enable_disable])
+        return false
+      end
+      disp.enabled = do_enable
+      return true
+    end
+    
+    def run_eval_display(args={})
+      for line in @displays.display(@frame) do 
+        msg(line)
+      end
+    end
+  end
+end

data/processor/eval.rb

@@ -0,0 +1,97 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'
+require 'require_relative'
+require_relative 'virtual'
+class Trepan::CmdProcessor < Trepan::VirtualCmdProcessor
+
+  def debug_eval(str, max_fake_filename=15)
+    begin
+      debug_eval_with_exception(str, max_fake_filename)
+    rescue SyntaxError, StandardError, ScriptError => e
+      exception_dump(e, @settings[:stack_trace_on_error], $!.backtrace)
+      nil
+    end
+  end
+  
+  def debug_eval_with_exception(str, max_fake_filename=15)
+    @frame.run(str, fake_eval_filename(str, max_fake_filename))
+  end
+  
+  def debug_eval_no_errmsg(str, max_fake_filename=15)
+    begin
+      debug_eval_with_exception(str, max_fake_filename)
+    rescue SyntaxError, StandardError, ScriptError => e
+      nil
+    end
+  end
+  
+  def eval_code(str, max_fake_filename)
+    obj = debug_eval(str, max_fake_filename)
+    
+    idx = @user_variables
+    @user_variables += 1
+    
+    str = "$d#{idx}"
+    Rubinius::Globals[str.to_sym] = obj
+    msg "#{str} = #{obj.inspect}"
+    obj
+  end
+  
+  def exception_dump(e, stack_trace, backtrace)
+    str = "#{e.class} Exception:\n\t#{e.message}"
+    if stack_trace
+      str += "\n" + backtrace.map{|l| "\t#{l}"}.join("\n") rescue nil
+    end
+    msg str
+    # throw :debug_error
+  end
+  
+  def fake_eval_filename(str, maxlen = 15)
+    fake_filename = 
+      if maxlen < str.size
+        # FIXME: Guard against \" in positions 13..15?
+        str.inspect[0..maxlen-1] + '"...'
+      else
+        str.inspect
+      end
+    "(eval #{fake_filename})"
+  end
+  
+end
+
+if __FILE__ == $0
+  # Demo it.
+  cmdp = Trepan::CmdProcessor.new([])
+  puts cmdp.fake_eval_filename('x = 1; y = 2')
+  puts cmdp.fake_eval_filename('x = 1; y = 2', 7)
+  def cmdp.errmsg(msg)
+    puts "** #{msg}"
+  end
+  def cmdp.msg(msg)
+    puts "#{msg}"
+  end
+  begin 
+    1/0
+  rescue Exception => exc
+    cmdp.exception_dump(exc, true, $!.backtrace)
+    puts '=' * 40
+  end
+
+  x = 10
+
+  require 'rubygems'; require 'require_relative'
+  require_relative '../app/frame'
+  frame = Trepan::Frame.new(self, 1, Rubinius::VM.backtrace(0)[0])
+  cmdp.instance_variable_set('@frame', frame)
+  cmdp.instance_variable_set('@settings', {:stack_trace_on_error => true})
+  def cmdp.errmsg(mess) ; puts mess end
+  # require_relative '../lib/trepanning'
+  # Trepan.start
+  puts cmdp.debug_eval('x = "#{x}"')
+  puts '=' * 40
+  puts cmdp.debug_eval('x+')
+  puts cmdp.debug_eval_no_errmsg('y+')
+  puts '=' * 40
+  puts cmdp.debug_eval('x+')
+  puts cmdp.debug_eval('y = 1; x+', 4)
+end