rbx-trepanning 0.2.0-universal-rubinius-2.0

data/processor/command/info_subcmd/files.rb

@@ -0,0 +1,219 @@
+# -*- 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 cm)
+
+    HELP = <<-EOH
+#{CMD} [{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.
+cm     -- Top-level compiled method found for this file
+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 cm sha1 size stat)
+
+  include Trepanning
+
+  def file_list
+    (LineCache.cached_files + 
+     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 'Canonic Files names cached:'
+      primary = LineCache.class_variable_get('@@file_cache')
+      remap = LineCache.class_variable_get('@@file2file_remap')
+      msg columnize_commands(remap.keys.uniq.sort)
+      names = remap.keys - primary.keys
+      unless names.empty?
+        section 'Non-canonic names cached:'
+        msg columnize_commands(names.sort)
+      end
+      return
+    end
+    filename = 
+      if '.' == args[2]
+        if not @proc.frame
+          errmsg("No frame - no default file.")
+          return false
+          nil
+        else
+          frame_file = @proc.frame.file
+          LineCache::map_file(frame_file) || File.expand_path(frame_file)
+        end
+      else
+        args[2]
+      end
+    args += DEFAULT_FILE_ARGS if args.size == 3
+
+    m = filename
+    canonic_name = @proc.canonic_file(filename)
+    canonic_name = LineCache::map_file(canonic_name) || canonic_name
+    if LineCache::cached?(canonic_name)
+      m += " is cached in debugger"
+      if canonic_name != filename
+        m += (" as:\n  " + 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[0])
+        m += " matched debugger cache file:\n  "  + canonic_name
+        msg m
+      else
+        msg(m + ' is 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 cm).member?(arg) 
+        unless seen[:cm]
+          if cm = LineCache.compiled_method(canonic_name)
+            msg("File has compiled method: #{cm}")
+          else
+            msg("Compiled method not recorded; there may be some, though.")
+          end
+        end
+        processed_arg = seen[:cm] = 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/frame.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'; require 'require_relative'
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoFrame < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = <<-EOH
+#{CMD} 
+
+Show information about the selected frame. The fields we list are:
+
+* A source container and name (e.g. "file" or "string" and the value)
+* The actual number of arguments passed in
+* The 'arity' or permissible number of arguments passed it. -1 indicates
+  variable number
+* The frame "type", e.g. TOP, METHOD, BLOCK, EVAL, CFUNC etc.
+* The return value if the frame is at a return point
+* The PC offset we are currently at; May be omitted of no instruction 
+  sequence
+
+A backtrace shows roughly the same information in a more compact form.
+
+Example form inside File.basename('foo')
+
+Frame basename
+  file  : /tmp/c-func.rb # actually location of caller
+  line  : 2  # inherited from caller
+  argc  : 1  # One out argument supplied: 'foo'
+  arity : -1 # Variable number of args, can have up to 2 arguments.
+  type  : CFUNC  (A C function)
+
+
+See also: backtrace
+    EOH
+    MIN_ABBREV   = 'fr'.size # Note we have "info file"
+    MIN_ARGS     = 0
+    MAX_ARGS     = 0
+    NEED_STACK   = true
+    SHORT_HELP   = 'Show information about the selected frame'
+  end
+
+  def run(args)
+    frame = @proc.frame
+    loc   = frame.vm_location
+    section "Frame %2d: #{frame.method.name}" % frame.number
+    msg "  in    : #{loc.describe_receiver}#{loc.name}"
+    msg "  file  : %s" % loc.method.active_path
+    msg "  line  : %s" % frame.line
+    # msg "  argc  : %d" % frame.argc
+    msg "  arity : %d" % frame.method.arity
+    # msg "  type  : %s" % frame.type
+    msg "  offset: %d" % frame.ip
+    # if %w(return c-return).member?(@proc.event)
+    #   ret_val = Trepan::Frame.value_returned(@proc.frame, @proc.event)
+    #   msg "  Return: %s" % ret_val
+    # end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoFrame, false)
+  cmd.run(cmd.prefix)
+end

data/processor/command/info_subcmd/line.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+require_relative '../../../app/iseq'
+
+
+class Trepan::Subcommand::InfoLine < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = <<-EOH
+#{CMD} [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
+
+  include Trepan::ISeq
+
+  def run(args)
+    frame = @proc.frame
+    vm_location = frame.vm_location
+    cm          = frame.method
+    filename    = cm.file
+    lines       = cm.lines
+    tail_code   = false
+    if args.size == 2
+      line_no     = vm_location.line
+      if line_no == 0
+        tail_code = true
+        line_no = frame.line
+      end
+    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, prefix = 
+      if tail_code
+        [ip_ranges_for_ip(lines, frame.next_ip), 'Tail code preceding line']
+      else
+        [ip_ranges_for_line(lines, line_no), 'Line']
+      end
+    if ranges.empty?
+      msg "%s %s of %s:\n\tno bytecode offsets" % [prefix, line_no, filename]
+    else
+      msg "%s %s of %s:" % [prefix, 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/locals.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoLocals < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = 'Same thing as "info locals"'
+    NEED_LOCALS   = true
+   end
+
+  def run(args)
+    @proc.commands['info'].run(%w(info variables locals))
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  # ???
+end

data/processor/command/info_subcmd/macro.rb

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+require_relative '../../../app/complete'
+
+class Trepan::Subcommand::InfoMacro < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP = <<-HELP
+#{CMD} 
+#{CMD} *
+#{CMD} MACRO1 [MACRO2 ..]
+
+In the first form a list of the existing macro names are shown
+in column format.
+
+In the second form, all macro names and their definitions are show.
+
+In the last form the only definitions of the given macro names is shown.
+    HELP
+    SHORT_HELP = "Info defined macros"
+    MIN_ABBREV = 'mac'.size
+  end
+
+  def complete(prefix)
+    Trepan::Complete.complete_token(@proc.macros.keys + %w(*), prefix)
+  end
+
+  def run(args)
+    if args.size > 2
+      macro_names = 
+        if args.size == 3 && '*' == args[2] 
+          @proc.macros.keys
+        else
+          args[2..-1]
+        end        
+      macro_names.each do |macro_name|
+        if @proc.macros.member?(macro_name)
+          section "#{macro_name}:"
+          string = @proc.macros[macro_name][1]
+          msg "  #{@proc.ruby_format(string)}", {:unlimited => true}
+        else
+          errmsg "%s is not a defined macro" % macro_name
+        end
+      end
+    elsif @proc.macros.empty?
+      msg "No macros defined."
+    else
+      msg columnize_commands(@proc.macros.keys.sort)
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this agin
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoMacro)
+  cmd.run(cmd.prefix + %w(u foo))
+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

data/processor/command/info_subcmd/program.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoProgram < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = 'Information about debugged program and its environment'
+    MIN_ARGS     = 0
+    MAX_ARGS     = 0
+    MIN_ABBREV   = 'pr'.size
+    NEED_STACK   = true
+   end
+
+  def run(args)
+    frame = @proc.frame
+    ## m = 'Program stop event: %s' % @proc.core.event
+    m = ''
+    m += "Frame index #{@proc.frame_index}, " if @proc.frame_index != 0
+    m += 
+      if frame.method
+        "PC offset %d of method: %s" %
+          [frame.next_ip, frame.method.name]
+      else
+        ## '.'
+      end
+    msg m
+    # if 'return' == @proc.core.event 
+    #   msg 'R=> %s' % @proc.frame.sp(1).inspect 
+    # elsif 'raise' == @proc.core.event
+    #   msg @proc.core.hook_arg.inspect if @proc.core.hook_arg
+    # end
+
+    if @proc.brkpt && @proc.brkpt.event == :Breakpoint
+      msg('It stopped at %sbreakpoint %d.' %
+          [@proc.brkpt.temp? ? 'temporary ' : '',
+           @proc.brkpt.id])
+    else
+      msg("Program stopped at a #{@proc.event} event.")
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoProgram, false)
+  cmd.run(cmd.prefix)
+end

data/processor/command/info_subcmd/ruby.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::InfoRuby < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = <<-EOH
+#{CMD} [-v|--verbose|-no-verbose]
+
+Show Ruby version information such as you'd get from 
+"rbx -v" (which is really just the value of RUBY_RELEASE_DATE),
+or from "rbx -vv". 
+
+See also constants: RUBY_DESCRIPITON, RUBY_VERSION, and RUBY_RELEASE_DATE."
+    EOH
+    MIN_ABBREV   = 'ru'.size
+    NEED_STACK   = false
+    MIN_ARGS     = 0
+    MAX_ARGS     = 0
+    SHORT_HELP   = 'Ruby version information'
+   end
+
+  def parse_options(args) # :nodoc
+    options = {}
+    parser = OptionParser.new do |opts|
+      opts.on("-v", 
+              "--[no-]verbose", "show additional version information") do
+        |v| 
+        options[:verbose] = v
+      end
+    end
+    parser.parse(args)
+    return options
+  end
+
+  def run(args)
+    options = parse_options(args[2..-1])
+    msg RUBY_DESCRIPTION
+    if options[:verbose]
+      msg "Options:"
+      msg "  Interpreter type: #{Rubinius::INTERPRETER}"
+      if jit = Rubinius::JIT
+        msg "  JIT enabled: #{jit.join(', ')}"
+      else
+        msg "  JIT disabled"
+      end
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this again
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoRuby, false)
+  cmd.run(cmd.prefix)
+  %w(-v --verbose --no-verbose).each do |opt|
+    puts '-' * 10 + " #{opt}"
+    cmd.run(cmd.prefix + [opt])
+  end
+end