rbx-trepanning 0.0.5-universal-rubinius-1.2.1

data/processor/command/info.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative 'base/submgr'
+
+class Trepan::Command::InfoCommand < Trepan::SubcommandMgr
+  unless defined?(HELP)
+    HELP =
+'Generic command for showing things about the program being debugged. 
+
+You can give unique prefix of the name of a subcommand to get
+information about just that subcommand.
+
+Type "info" for a list of "info" subcommands and what they do.
+Type "help info *" for just a list of "info" subcommands.
+'
+
+    ALIASES       = %w(i)
+    CATEGORY      = 'status'
+    NAME          = File.basename(__FILE__, '.rb')
+    SHORT_HELP    = 'Information about debugged program and its environment'
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+end

data/processor/command/info_subcmd/breakpoints.rb

@@ -0,0 +1,73 @@
+# -*- 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
+#{PREFIX.join(' ')} [num1 ...] [verbose]
+
+Show status of user-settable breakpoints. If no breakpoint numbers are
+given, the show all breakpoints. Otherwise only those breakpoints
+listed are shown and the order given. If VERBOSE is given, more
+information provided about each breakpoint.
+
+The "Disp" column contains one of "keep", "del", the disposition of
+the breakpoint after it gets hit.
+
+The "enb" column indicates whether the breakpoint is enabled.
+
+The "Where" column indicates where the breakpoint is located.
+EOH
+  MIN_ABBREV   = 'br'.size
+  SHORT_HELP   = 'Status of user-settable breakpoints'
+  
+  def run(args)
+    show_all = 
+      if args.size > 2
+        opts = {
+        :msg_on_error => 
+        "An '#{PREFIX.join(' ')}' argument must eval to a breakpoint between 1..#{@proc.brkpts.max}.",
+        :min_value => 1,
+        :max_value => @proc.brkpts.max
+      }
+        bp_nums = @proc.get_int_list(args[2..-1])
+        false
+      else
+        true
+      end
+
+    bpmgr = @proc.brkpts
+    if bpmgr.empty? && @proc.dbgr.deferred_breakpoints.empty?
+      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
+      section 'Deferred breakpoints...'
+      @proc.dbgr.deferred_breakpoints.each_with_index do |bp, i|
+        if bp
+          msg "%3d: %s" % [i+1, bp.describe]
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoBreakpoints.new(cmd)
+
+  puts '-' * 20
+  subcommand.run(%w(info break))
+  puts '-' * 20
+  subcommand.summary_help(name)
+  puts
+  puts '-' * 20
+end

data/processor/command/info_subcmd/files.rb

@@ -0,0 +1,209 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require 'linecache'
+require 'columnize'
+require_relative '../base/subcmd'
+require_relative '../../../app/complete'
+
+class Trepan::Subcommand::InfoFiles < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    DEFAULT_FILE_ARGS = %w(size mtime sha1)
+
+    HELP = <<-EOH
+#{CMD=PREFIX.join(' ')} [{FILENAME|.|*} [all|ctime|brkpts|mtime|sha1|size|stat]]
+
+Show information about the current file. If no filename is given and
+the program is running, then the current file associated with the
+current stack entry is used. Giving . has the same effect. 
+
+Given * gives a list of all files we know about.
+
+Sub options which can be shown about a file are:
+
+brkpts -- Line numbers where there are statement boundaries. 
+          These lines can be used in breakpoint commands.
+ctime  -- File creation time
+mtime  -- File modification time
+sha1   -- A SHA1 hash of the source text. This may be useful in comparing
+          source code.
+size   -- The number of lines in the file.
+stat   -- File.stat information
+
+all    -- All of the above information.
+
+If no sub-options are given, "#{DEFAULT_FILE_ARGS.join(' ')}" are assumed.
+
+Examples:
+
+#{CMD}    # Show #{DEFAULT_FILE_ARGS.join(' ')} information about current file
+#{CMD} .  # same as above
+#{CMD} brkpts      # show the number of lines in the current file
+#{CMD} brkpts size # same as above but also list breakpoint line numbers
+#{CMD} *  # Give a list of files we know about
+EOH
+    MIN_ABBREV   = 'fi'.size  # Note we have "info frame"
+    NEED_STACK   = false
+  end
+
+  # completion %w(all brkpts iseq sha1 size stat)
+
+  include Trepanning
+
+  def file_list
+    (LineCache.class_variable_get('@@file_cache').keys +
+     LineCache.class_variable_get('@@file2file_remap').keys).uniq
+  end
+  def complete(prefix)
+    completions = ['.'] + file_list
+    Trepan::Complete.complete_token(completions, prefix)
+  end
+  
+  # Get file information
+  def run(args)
+    return if args.size < 2
+    args << '.' if 2 == args.size 
+    if '*' == args[2]
+      section 'Files names cached:'
+      msg columnize_commands(file_list.sort)
+      return
+    end
+    filename = 
+      if '.' == args[2]
+        if not @proc.frame
+          errmsg("No frame - no default file.")
+          return false
+          nil
+        else
+          File.expand_path(@proc.frame.file)
+        end
+      else
+        args[2]
+      end
+    args += DEFAULT_FILE_ARGS if args.size == 3
+
+    m = filename + ' is'
+    canonic_name = LineCache::map_file(filename) || filename
+    if LineCache::cached?(canonic_name)
+      m += " cached in debugger"
+      if canonic_name != filename
+        m += (' as:' + canonic_name)
+      end
+      m += '.'
+      msg(m)
+    # elsif !(matches = find_scripts(filename)).empty?
+    #   if (matches.size > 1)
+    #     msg("Multiple files found:")
+    #     matches.each { |filename| msg("\t%s" % filename) }
+    #     return
+    #   else
+    #     msg('File "%s" just now cached.' % filename)
+    #     LineCache::cache(matches[0])
+    #     LineCache::remap_file(matches[0], filename)
+    #     canonic_name = matches[0]
+    #   end
+    else
+      matches = file_list.select{|try| try.end_with?(filename)}
+      if (matches.size > 1)
+        msg("Multiple files found ending filename string:")
+        matches.sort.each { |match_file| msg "\t%s" % match_file }
+        return
+      elsif 1 == matches.size
+        canonic_name = LineCache::map_file(matches[1])
+      else
+        msg(m + ' not cached in debugger.')
+        return
+      end
+    end
+    seen = {}
+    args[3..-1].each do |arg|
+      processed_arg = false
+
+      if %w(all size).member?(arg) 
+        unless seen[:size]
+          max_line = LineCache::size(canonic_name)
+          msg "File has %d lines." % max_line if max_line
+        end
+        processed_arg = seen[:size] = true
+      end
+
+      if %w(all sha1).member?(arg)
+        unless seen[:sha1]
+          msg("SHA1 is %s." % LineCache::sha1(canonic_name))
+        end
+        processed_arg = seen[:sha1] = true
+      end
+
+      if %w(all brkpts).member?(arg)
+        unless seen[:brkpts]
+          msg("Possible breakpoint line numbers:")
+          lines = LineCache::trace_line_numbers(canonic_name)
+          fmt_lines = columnize_numbers(lines)
+          msg(fmt_lines)
+        end
+        processed_arg = seen[:brkpts] = true
+      end
+
+      if %w(all ctime).member?(arg)
+        unless seen[:ctime]
+          msg("create time:\t%s." % 
+              LineCache::stat(canonic_name).ctime.to_s)
+        end
+        processed_arg = seen[:ctime] = true
+      end
+      
+      # if %w(all iseq).member?(arg) 
+      #   unless seen[:iseq]
+      #     if SCRIPT_ISEQS__.member?(canonic_name)
+      #       msg("File contains instruction sequences:")
+      #       SCRIPT_ISEQS__[canonic_name].each do |iseq|
+      #         msg("\t %s %s" % [iseq, iseq.name.inspect])
+      #       end 
+      #     else
+      #       msg("Instruction sequences not recorded; there may be some, though.")
+      #     end
+      #   end
+      #   processed_arg = seen[:iseq] = true
+      # end
+
+      if %w(all mtime).member?(arg)
+        unless seen[:mtime]
+          msg("modify time:\t%s." % 
+              LineCache::stat(canonic_name).mtime.to_s)
+        end
+        processed_arg = seen[:mtime] = true
+      end
+      
+      if %w(all stat).member?(arg)
+        unless seen[:stat]
+          msg("Stat info:\n\t%s." % LineCache::stat(canonic_name).inspect)
+        end
+        processed_arg = seen[:stat] = true
+      end
+
+      if not processed_arg
+        errmsg("I don't understand sub-option \"%s\"." % arg)
+      end
+    end unless args.empty?
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoFiles, false)
+  LineCache::cache(__FILE__)
+  LineCache::cache('../../mock.rb')
+  
+  [%w(info file nothere),
+   %w(info file .),
+   %w(info file *),
+   %w(info file),
+   %W(info file #{__FILE__}),
+   %W(info file #{__FILE__} all),
+   %W(info file #{__FILE__} brkpts bad size sha1 sha1)].each do |args|
+    cmd.run(args)
+    puts '-' * 40
+  end
+  p cmd.complete('')
+end

data/processor/command/info_subcmd/line.rb

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoLine < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = <<-EOH
+#{CMD=PREFIX.join(' ')} [LINE-NUMBER]
+
+Show bytecode offset for LINE-NUMBER. If no LINE-NUMBER is given, 
+then we use the current line that we are stopped in.
+
+Examples:
+#{CMD} 
+#{CMD} 10
+    EOH
+    MIN_ABBREV   = 'li'.size
+    NEED_STACK   = true
+    SHORT_HELP   = 'Byte code offsets for source code line'
+   end
+
+  def ip_ranges_for_line(lines, line)
+    result = []
+    in_range = false
+    start_ip = nil
+    total = lines.size
+    i = 1
+    while i < total
+      cur_line = lines.at(i)
+      if cur_line == line
+        start_ip = lines.at(i-1)
+        in_range = true
+      elsif cur_line > line && in_range
+        result << [start_ip, lines.at(i-1)]
+        start_ip = nil
+        in_range = false
+      end
+      i += 2
+    end
+    if in_range && start_ip
+      result << [start_ip, lines.at(total-1)]
+    end
+    result
+  end
+  
+  def run(args)
+    frame = @proc.frame
+    vm_location = frame.vm_location
+    cm          = frame.method
+    filename    = cm.file
+    lines       = cm.lines
+    if args.size == 2
+      line_no     = vm_location.line
+    else
+      lineno_str = args[2]
+      opts = {
+        :msg_on_error =>
+        "The 'info line' line number must be an integer. Got: %s" % lineno_str,
+        :min_value => lines.at(1),
+        :max_value => lines.at(lines.size-2)
+      }
+      line_no = @proc.get_an_int(lineno_str, opts)
+      return false unless line_no
+    end
+      
+    ranges      = ip_ranges_for_line(lines, line_no)
+    if ranges.empty?
+      msg "Line %s of %s:\n\tno bytecode offsets" % [line_no, filename]
+    else
+      msg "Line %s of %s:" % [line_no, filename]
+      ranges.each do |tuple|
+        msg "\t starts at offset %d and ends before offset %d" % tuple
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoLine, false)
+  cmd.run(cmd.prefix)
+end

data/processor/command/info_subcmd/method.rb

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoMethod < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = <<-EOH
+#{PREFIX.join(' ')} [METHOD|.]
+
+Show information about a method.
+
+Examples:
+  #{PREFIX.join(' ')}
+  #{PREFIX.join(' ')} .
+  #{PREFIX.join(' ')} require_relative
+EOH
+
+    MIN_ABBREV   = 'me'.size
+    NEED_STACK   = true
+    SHORT_HELP   = 'Information about a (compiled) method'
+  end
+
+  def run(args)
+    if args.size <= 2
+      method_name = '.'
+    else
+      method_name = args[2]
+    end
+    if '.' == method_name
+      meth = @proc.frame.method
+    # elsif ...
+    #   # FIXME: do something if there is more than one
+    else
+      meth = nil
+    end
+    
+    if meth
+      msg("Method #{meth.name}():")
+      %w(arity         child_methods describe
+         file          first_line    lines         local_count
+         required_args splat         stack_size    total_args 
+         ).each do |field|
+        msg "  %-15s: %s" % [field, meth.send(field).inspect]
+      end
+    else
+      mess = "Can't find method"
+      mess += " for #{args.join(' ')}" unless args.empty?
+      errmsg mess
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+
+  require_relative '../../mock'
+  require_relative '../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('info')
+  subcommand = Trepan::Subcommand::InfoMethod.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  subcommand.run([name])
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end