rbx-trepanning 0.0.5-universal-rubinius-1.2.1

data/processor/subcmd.rb

@@ -0,0 +1,161 @@
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# gdb-like subcommand processing.
+
+class Trepan
+  class Subcmd
+
+    attr_reader :subcmds  # Hash of subcommands. Key is the subcommand name.
+                          # the value is the subcommand object to run.
+    def initialize(cmd)
+      @cmd     = cmd
+      @subcmds = {}
+      @cmdlist = []
+    end
+    
+    # Find subcmd in self.subcmds
+    def lookup(subcmd_prefix, use_regexp=true)
+      compare = if use_regexp 
+                  lambda{|name| name.to_s =~ /^#{subcmd_prefix}/}
+                else
+                  lambda{|name| 0 == name.to_s.index(subcmd_prefix)}
+                end
+      @subcmds.each do |subcmd_name, subcmd|
+        if compare.call(subcmd_name) &&
+            subcmd_prefix.size >= subcmd.class.const_get(:MIN_ABBREV)
+          return subcmd
+        end
+      end
+      return nil
+    end
+
+    # Show short help for a subcommand.
+    def short_help(subcmd_cb, subcmd_name, label=false)
+      entry = self.lookup(subcmd_name)
+      if entry
+        if label
+          prefix = entry.name
+        else
+          prefix = ''
+        end
+        if entry.respond_to?(:short_help)
+          prefix += ' -- ' if prefix 
+          @proc.msg(prefix + entry.short_help)
+        end
+      else
+        @proc.undefined_subcmd("help", subcmd_name)
+      end
+    end
+
+    # Add subcmd to the available subcommands for this object.
+    # It will have the supplied docstring, and subcmd_cb will be called
+    # when we want to run the command. min_len is the minimum length
+    # allowed to abbreviate the command. in_list indicates with the
+    # show command will be run when giving a list of all sub commands
+    # of this object. Some commands have long output like "show commands"
+    # so we might not want to show that.
+    def add(subcmd_cb, subcmd_name=nil)
+      subcmd_name ||= subcmd_cb.name
+      @subcmds[subcmd_name.to_s] = subcmd_cb
+
+      # We keep a list of subcommands to assist command completion
+      @cmdlist << subcmd_name
+    end
+
+    # Run subcmd_name with args using obj for the environent
+    def run( subcmd_name, arg)
+      entry=lookup(subcmd_name)
+      if entry
+        entry['callback'].send(arg)
+      else
+        @proc.undefined_cmd(entry.__class__.name, subcmd_name)
+      end
+    end
+
+    # help for subcommands
+    # Note: format of help is compatible with ddd.
+    def help(*args)
+
+      msg args
+      subcmd_prefix = args[0]
+      if not subcmd_prefix or subcmd_prefix.size == 0
+        @proc.msg(self.doc)
+        @proc.msg("\nList of %s subcommands:\n" % [@name])
+        @list.each do |subcmd_name|
+          subcmd_helper(subcmd_name, obj, true, true)
+        end
+
+        entry = lookup(subcmd_prefix)
+        if entry and entry.respond_to? :help
+          entry.help(args)
+        else
+          @proc.errmsg("Unknown 'help %s' subcommand %s" %
+                       [@name, subcmd_prefix])
+        end
+      end
+    end
+
+    def list
+      @subcmds.keys.sort
+    end
+    
+    # Error message when a subcommand doesn't exist.
+    def undefined_subcmd(cmd, subcmd)
+      @proc.errmsg('Undefined "%s" command: "%s". Try "help".' % 
+                   [cmd, subcmd])
+    end
+  end
+end
+
+# When invoked as main program, invoke the debugger on a script
+if __FILE__ == $0
+
+  require 'rubygems'; require 'require_relative'
+  require_relative 'mock'
+  require_relative 'command/base/cmd'
+
+  class Trepan::TestCommand < Trepan::Command
+    
+    HELP = 'Help string string for testing'
+    CATEGORY = 'data'
+    MIN_ARGS = 0
+    MAX_ARGS = 5
+    NAME_ALIASES = %w(test)
+    
+    def initialize(proc); @proc  = proc end
+    
+    def run(args); puts 'test command run' end
+  end
+  
+  class TestTestingSubcommand
+    HELP = 'Help string for test testing subcommand'
+    
+    def initialize; @name  = 'testing' end
+    
+    SHORT_HELP = 'This is short help for test testing'
+    MIN_ABREV = 4
+    IN_LIST   = true
+    def run(args); puts 'test testing run' end
+  end
+
+  d = MockDebugger::MockDebugger.new
+  testcmd    = Trepan::TestCommand.new(nil)
+  # testcmd.debugger = d
+  # testcmd.proc     = d.core.processor
+  # testcmdMgr = Subcmd.new('test', testcmd)
+  # testsub = TestTestingSubcommand.new
+  # testcmdMgr.add(testsub)
+  
+  # %w(tes test testing testing1).each do |prefix|
+  #   x = testcmdMgr.lookup(prefix)
+  #   puts x ? x.name : 'Non'
+  # end
+  
+  # testcmdMgr.short_help(testcmd, 'testing')
+  # testcmdMgr.short_help(testcmd, 'test', true)
+  # testcmdMgr.short_help(testcmd, 'tes')
+  # puts testcmdMgr.list()
+  # testsub2 = TestTestingSubcommand.new
+  # testsub2.name = 'foobar'
+  # testcmdMgr.add(testsub2)
+  # puts testcmdMgr.list()
+end

data/processor/validate.rb

@@ -0,0 +1,355 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+
+# Trepan command input validation routines.  A String type is
+# usually passed in as the argument to validation routines.
+
+require 'rubygems'
+require 'require_relative'
+require 'linecache'
+require_relative '../app/method'
+require_relative '../app/validate'
+## require_relative '../app/condition'
+## require_relative '../app/file'
+class Trepan
+  class CmdProcessor
+
+    attr_reader :dbgr_script_iseqs
+    attr_reader :dbgr_iseqs
+
+    include Trepanning::Method
+    include Trepan::Validate
+    ## include Trepan::ThreadHelper
+    ## include Trepan::Condition
+
+    def confirm(msg, default)
+      @settings[:confirm] ? @dbgr.intf[-1].confirm(msg, default) : true
+    end
+
+    # Like cmdfns.get_an_int(), but if there's a stack frame use that
+    # in evaluation.
+    def get_an_int(arg, opts={})
+      ret_value = get_int_noerr(arg)
+      if !ret_value
+        if opts[:msg_on_error]
+          errmsg(opts[:msg_on_error])
+        else
+          errmsg("Expecting an integer, got: #{arg}.")
+        end
+        return nil
+      end
+      if opts[:min_value] and ret_value < opts[:min_value]
+        errmsg("Expecting integer value to be at least %d; got %d." %
+               [opts[:min_value], ret_value])
+        return nil
+      elsif opts[:max_value] and ret_value > opts[:max_value]
+        errmsg("Expecting integer value to be at most %d; got %d." %
+               [opts[:max_value], ret_value])
+        return nil
+      end
+      return ret_value
+    end
+
+    unless defined?(DEFAULT_GET_INT_OPTS)
+      DEFAULT_GET_INT_OPTS = {
+        :min_value => 0, :default => 1, :cmdname => nil, :max_value => nil}
+    end
+
+    # If argument parameter 'arg' is not given, then use what is in
+    # opts[:default]. If String 'arg' evaluates to an integer between
+    # least min_value and at_most, use that. Otherwise report an
+    # error.  If there's a stack frame use that for bindings in
+    # evaluation.
+    def get_int(arg, opts={})
+      
+      return default unless arg
+      opts = DEFAULT_GET_INT_OPTS.merge(opts)
+      val = arg ? get_int_noerr(arg) : opts[:default]
+      unless val
+        if opts[:cmdname]
+          errmsg(("Command '%s' expects an integer; " +
+                  "got: %s.") % [opts[:cmdname], arg])
+        else
+          errmsg('Expecting a positive integer, got: %s' % arg)
+        end
+        return nil
+      end
+      
+      if val < opts[:min_value]
+        if opts[:cmdname]
+          errmsg(("Command '%s' expects an integer at least" +
+                  ' %d; got: %d.') %
+                 [opts[:cmdname], opts[:min_value], opts[:default]])
+        else
+          errmsg(("Expecting a positive integer at least" +
+                  ' %d; got: %d') %
+                 [opts[:min_value], opts[:default]])
+        end
+        return nil
+      elsif opts[:max_value] and val > opts[:max_value]
+        if opts[:cmdname]
+          errmsg(("Command '%s' expects an integer at most" +
+                  ' %d; got: %d.') %
+                 [opts[:cmdname], opts[:max_value], val])
+        else
+          errmsg(("Expecting an integer at most %d; got: %d") %
+                 [opts[:max_value], val])
+        end
+        return nil
+      end
+      return val
+    end
+
+    def get_int_list(args, opts={})
+      args.map{|arg| get_an_int(arg, opts)}.compact
+    end
+    
+    # Eval arg and it is an integer return the value. Otherwise
+    # return nil
+    def get_int_noerr(arg)
+      b = @frame ? @frame.binding : nil
+      val = Integer(eval(arg, b))
+    rescue SyntaxError
+      nil
+    rescue 
+      nil
+    end
+
+    def get_thread_from_string(id_or_num_str)
+      if id_or_num_str == '.'
+        Thread.current
+      elsif id_or_num_str.downcase == 'm'
+        Thread.main
+      else
+        num = get_int_noerr(id_or_num_str)
+        if num
+          get_thread(num)
+        else
+          nil
+        end
+      end
+    end
+
+    # Parse a breakpoint position. On success return
+    #   - a string "description" 
+    #   - the method the position is in - a CompiledMethod or a String
+    #   - the line - a Fixnum
+    #   - whether the position is an instance or not
+    # On failure, an error message is shown and we return nil.
+    def breakpoint_position(args)
+      ip = nil
+      if args.size == 0
+        args = [frame.line.to_s]
+      end
+      if args[0] == 'main.__script__'
+        if args.size > 2
+          errmsg 'Expecting only a line number'
+          return nil
+        elsif args.size == 2
+          ip, line = line_or_ip(args[1])
+          unless line || ip
+            errmsg ("Expecting a line or an IP offset number")
+            return nil 
+          end
+        else
+          ip, line = nil, nil
+        end
+        return [args.join(' '), '.', '__script__', line, ip]
+      elsif args.size == 1
+        meth = parse_method(args[0])
+        if meth
+          cm = meth.executable
+          return [args[0], nil, true, cm, cm.lines[1], cm.lines[0]]
+        else
+          m = /([A-Z]\w*(?:::[A-Z]\w*)*)([.#])(\w+[!?=]?)(?:[:]([oO])?(\d+))?/.match(args[0])
+          if m
+            if m[4]
+              return [m[0], m[1], m[2], m[3], nil, m[5] ? m[5].to_i : nil]
+            else
+              return [m[0], m[1], m[2], m[3], (m[4] ? m[4].to_i : nil), nil]
+            end
+          else
+            ip, line = line_or_ip(args[0])
+            unless line || ip
+              errmsg ("Expecting a line or an IP offset number")
+              return nil 
+            end
+            if line
+              meth = find_method_with_line(frame.method, line)
+              unless meth
+                errmsg "Cannot find method location for line #{line}"
+                return nil 
+              end
+            elsif valid_ip?(frame.method, ip)
+              return [args.join(' '), meth.class, '#', frame.method, nil, ip]
+            else
+              errmsg 'Cannot parse breakpoint location'
+              return nil
+            end
+            
+            return ["#{meth.describe}", nil, '#', meth, line, nil]
+          end
+        end
+      end
+      errmsg 'Cannot parse breakpoint location'
+      return nil
+    end
+
+    # Return true if arg is 'on' or 1 and false arg is 'off' or 0.
+    # Any other value is raises TypeError.
+    def get_onoff(arg, default=nil, print_error=true)
+      unless arg
+        if !default
+          if print_error
+            errmsg("Expecting 'on', 1, 'off', or 0. Got nothing.")
+          end
+          raise TypeError
+        end
+        return default
+      end
+      darg = arg.downcase
+      return true  if arg == '1' || darg == 'on'
+      return false if arg == '0' || darg =='off'
+
+      errmsg("Expecting 'on', 1, 'off', or 0. Got: %s." % arg.to_s) if
+        print_error
+      raise TypeError
+    end
+
+    def method?(method_string)
+      obj, type, meth = 
+        if method_string =~ /(.+)(#|::|\.)(.+)/
+          [$1, $2, $3]
+        else
+          ['self', '.', method_string]
+        end
+      ret = debug_eval_no_errmsg("#{obj}.method(#{meth.inspect})")
+      return true if ret 
+      return debug_eval_no_errmsg("#{obj}.is_a?(Class)") &&
+        debug_eval_no_errmsg("#{obj}.method_defined?(#{meth.inspect})")
+    end
+
+    # parse_position(self, arg)->(fn, container, lineno)
+    # 
+    # Parse arg as [filename:]lineno | function | module
+    # Make sure it works for C:\foo\bar.py:12
+    def parse_position(arg, old_mod=nil, allow_offset = false)
+        colon = arg.rindex(':') 
+        if colon
+          # First handle part before the colon
+          arg1 = arg[0...colon].rstrip
+          lineno_str = arg[colon+1..-1].lstrip
+          mf, container, lineno = parse_position_one_arg(arg1, old_mod, false, allow_offset)
+          return nil, nil, nil unless container
+          filename = canonic_file(arg1) 
+          # Next handle part after the colon
+          val = get_an_int(lineno_str)
+          lineno = val if val
+        else
+          mf, container, lineno = parse_position_one_arg(arg, old_mod, true, allow_offset)
+        end
+
+        return mf, container, lineno
+    end
+
+    # parse_position_one_arg(self,arg)->(module/function, container, lineno)
+    #
+    # See if arg is a line number, function name, or module name.
+    # Return what we've found. nil can be returned as a value in
+    # the triple.
+    def parse_position_one_arg(arg, old_mod=nil, show_errmsg=true, allow_offset=false)
+      name, filename = nil, nil, nil
+      begin
+        # First see if argument is an integer
+        lineno    = Integer(arg)
+      rescue
+      else
+        filename  = @frame.file
+        return nil, canonic_file(filename), lineno
+      end
+
+      # Next see if argument is a file name 
+      if LineCache::cached?(arg)
+        return nil, canonic_file(arg), 1 
+      elsif File.readable?(arg)
+        return nil, canonic_file(arg), 1 
+      end
+
+      # How about a method name with an instruction sequence?
+      meth = parse_method(arg)
+      if meth
+        cm = meth.executable
+        return arg, canonic_file(cm.active_path), cm.lines[1]
+      end
+
+      if show_errmsg
+        unless (allow_offset && arg.size > 0 && arg[0].downcase == 'o')
+          errmsg("#{arg} is not a line number, filename or method " +
+                 "we can get location information about")
+        end
+      end
+      return nil, nil, nil
+    end
+    
+    def parse_method(meth_str)
+      # For meth_str = "foo", try via method("foo".to_sym)
+      str = "method(#{meth_str.inspect}.to_sym)"
+      meth = debug_eval_no_errmsg(str)
+      return meth if meth
+      last_dot = meth_str.rindex('.')
+      if last_dot
+        # For meth_str = "a.b.foo",
+        # try via a.b.method("foo".to_sym)
+        try_eval = "#{meth_str[0..last_dot]}method" + 
+          "(#{meth_str[last_dot+1..-1].inspect}.to_sym)"
+        meth = debug_eval_no_errmsg(try_eval)
+      end
+      return meth
+    end
+
+    def validate_initialize
+      ## top_srcdir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+      ## @dbgr_script_iseqs, @dbgr_iseqs = filter_scripts(top_srcdir)
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative './mock'
+  dbgr, cmd = MockDebugger::setup('exit', false)
+  proc  = cmd.proc
+  onoff = %w(1 0 on off)
+  onoff.each { |val| puts "onoff(#{val}) = #{proc.get_onoff(val)}" }
+  %w(1 1E bad 1+1 -5).each do |val| 
+    puts "get_int_noerr(#{val}) = #{proc.get_int_noerr(val).inspect}" 
+  end
+  def foo; 5 end
+  def proc.errmsg(msg)
+    puts msg
+  end
+  puts proc.parse_position_one_arg('tmpdir.rb').inspect
+  
+  puts '=' * 40
+  ['Array#map', 'Trepan::CmdProcessor.new',
+   'foo', 'proc.errmsg'].each do |str|
+    puts "#{str} should be true: #{proc.method?(str).inspect}"
+  end
+  puts '=' * 40
+  
+  # FIXME:
+  # Array#foo should be false: true
+  # Trepan::CmdProcessor.allocate should be false: true
+  
+  ['food', '.errmsg'].each do |str|
+    puts "#{str} should be false: #{proc.method?(str).inspect}"
+  end
+  puts '-' * 20
+  # require_relative '../lib/trepanning'
+  # Trepan.start
+  p proc.breakpoint_position(%w(O0))
+  p proc.breakpoint_position(%w(1))
+  p proc.breakpoint_position(%w(__LINE__))
+  # p proc.breakpoint_position(%w(2 if a > b))
+  p proc.get_int_list(%w(1+0 3-1 3))
+  p proc.get_int_list(%w(a 2 3))
+end