trepanning 0.0.4

data/processor/command/show_subcmd/trace_subcmd/print.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::ShowTracePrint < Trepan::ShowBoolSubSubcommand
+  unless defined?(HELP)
+    HELP = "Show tracing print status"
+    MIN_ABBREV   = 'p'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    PREFIX       = %w(show trace buffer)
+    SHORT_HELP   = "Show tracing print status"
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  require_relative '../../../subcmd'
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, show_cmd = MockDebugger::setup('show')
+  testcmdMgr     = Trepan::Subcmd.new(show_cmd)
+  trace_cmd      = Trepan::SubSubcommand::ShowTrace.new(dbgr.core.processor, 
+                                                        show_cmd)
+
+  # FIXME: remove the 'join' below
+  cmd_name       = Trepan::SubSubcommand::ShowTracePrint::PREFIX.join('')
+  tb_cmd         = Trepan::SubSubcommand::ShowTracePrint.new(show_cmd.proc, 
+                                                             trace_cmd,
+                                                             cmd_name)
+  # require_relative '../../../../lib/trepanning'
+  # dbgr = Trepan.new(:set_restart => true)
+  # dbgr.debugger
+  tb_cmd.run([])
+
+end

data/processor/command/source.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+
+# Our local modules
+require_relative 'base/cmd'
+require_relative '../../interface/script'
+# Mfile     = import_relative('file', '...lib', 'pydbgr')
+
+class Trepan::Command::SourceCommand < Trepan::Command
+  unless defined?(HELP)
+    HELP = "source [-v][-Y|-N][-c] FILE
+
+Read debugger commands from a file named FILE.  Optional -v switch
+(before the filename) causes each command in FILE to be echoed as it
+is executed.  Option -Y sets the default value in any confirmation
+command to be 'yes' and -N sets the default value to 'no'.
+
+Note that the command startup file '.pydbgrc' is read automatically
+via a source command the debugger is started.
+
+An error in any command terminates execution of the command file
+unless option -c is given.
+    "
+    CATEGORY     = 'support'
+    MIN_ARGS     = 1  # Need at least this many
+    MAX_ARGS     = nil
+    NAME         = File.basename(__FILE__, '.rb')
+    SHORT_HELP   = 'Read and run debugger commands from a file'
+  end
+
+  def run(args)
+    verbose = false
+    parms   = args[1..-1]
+    opts    = {}
+    parms.each do |arg|
+      case arg
+      when '-v'
+        opts[:verbose]        = true
+      when '-Y'
+        opts[:confirm_val]    = true
+      when '-N'
+        opts[:confirm_val]    = false
+      when '-c'
+        opts[:abort_on_error] = false
+      end
+    end
+    
+    filename = args[-1]
+    
+    expanded_file = File.expand_path(filename)
+    unless File.readable?(expanded_file)
+      errmsg("Debugger command file '%s' is not a readable file" % filename)
+      return false
+    end
+    
+    # Push a new debugger interface.
+    intf = @proc.dbgr.intf
+    script_intf = Trepan::ScriptInterface.new(expanded_file,
+                                              intf[-1].output,
+                                              opts)
+    intf << script_intf
+    return false
+  end
+end
+  
+# Demo it
+if __FILE__ == $0
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+  if ARGV.size > 1 
+    cmd.run([name, *ARGV])
+  end
+end

data/processor/command/step.rb

@@ -0,0 +1,139 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/cmd'
+require_relative '../../app/condition'
+class Trepan::Command::StepCommand < Trepan::Command
+
+  unless defined?(HELP)
+    HELP =
+"step[+|=|-|<|>|!|<>] [into] [EVENT-NAME...] [count]
+step until EXPRESSION
+step thread
+step to METHOD-NAME
+step over 
+step out
+
+Execute the current line, stopping at the next event.  Sometimes this
+is called 'step into'.
+
+With an integer argument, step that many times.  With an 'until'
+expression that expression is evaluated and we stop the first time it
+is true.
+
+EVENT-NAME... is list of an event name which is one on 'call',
+'return', 'line', 'exception' 'c-call', 'c-return' or 'c-exception'.
+If specified, only those stepping events will be considered. If no
+list of event names is given, then any event triggers a stop when the
+count is 0.
+
+There is however another way to specify an *single* EVENT-NAME, by
+suffixing one of the symbols '<', '>', or '!' after the command or on
+an alias of that.  A suffix of '+' on a command or an alias forces a
+move to another position, while a suffix of '-' disables this
+requirement.  A suffix of '>' will continue until the next
+call. ('finish' will run run until the return for that call.)
+
+If no suffix is given, the debugger setting 'different' determines
+this behavior.
+
+Examples: 
+  step        # step 1 event, *any* event obeying 'set different' setting
+  step 1      # same as above
+  step+       # same but force stopping on a new line
+  step=       # same but force stopping on a new line a new frame added
+  step-       # same but force stopping on a new line a new frame added
+  step 5/5+0  # same as above
+  step line   # step only line events
+  step call   # step only call call events
+  step>       # step call and C-call events
+  step<       # step only return and C-return events
+  step call line   # Step line *and* call events
+  step<>      # same as step call c-call return c-return 
+  step until a > b
+  step over   # same as 'next'
+  step out    # same as 'finish'
+  step thread # step stopping only in the current thread. Is the same
+              # as step until Thread.current.object_id == #object_id
+
+Related and similar is the 'next' (step over) and 'finish' (step out)
+commands.  All of these are slower than running to a breakpoint.
+
+See also the commands:
+'skip', 'jump' (there's no 'hop' yet), 'continue', 'return' and
+'finish' for other ways to progress execution.
+"
+
+    ALIASES      = %w(s step+ step- step< step> step<> step! s> s< s+ s- 
+                      s<> s! s=)
+    CATEGORY     = 'running'
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_RUNNING = true
+    SHORT_HELP   = 'Step program (possibly entering called functions)'
+
+    Keyword_to_related_cmd = {
+      'out'  => 'finish',
+      'over' => 'next',
+      'into' => 'step',
+    }
+  end
+
+  include Trepan::Condition
+  # This method runs the command
+  def run(args) # :nodoc
+    opts = @proc.parse_next_step_suffix(args[0])
+    condition = nil
+    if args.size == 1
+      # Form is: "step" which means "step 1"
+      step_count = 0
+    else
+      replace_cmd = Keyword_to_related_cmd[args[1]]
+      if replace_cmd
+        cmd = @proc.commands[replace_cmd]
+        return cmd.run([replace_cmd] + args[2..-1])
+      elsif 'until' == args[1]
+        try_condition = args[2..-1].join(' ')
+        if valid_condition?(try_condition)
+          condition = try_condition
+          opts[:different_pos] = false
+          step_count = 0
+        end
+      elsif 'to' == args[1]
+        if args.size != 3
+          errmsg('Expecting a method name after "to"')
+          return
+        elsif !@proc.method?(args[2])
+          errmsg("#{args[2]} doesn't seem to be a method name")
+          return
+        else
+          opts[:to_method] = args[2]
+          opts[:different_pos] = false
+          step_count = 0
+        end
+      elsif 'thread' == args[1]
+        condition = "Thread.current.object_id == #{Thread.current.object_id}"
+        opts[:different_pos] = false
+        step_count = 0
+      else
+        count_str = args[1]
+        int_opts = {
+          :msg_on_error => 
+          "The 'step' command argument must eval to an integer. Got: %s" % 
+          count_str,
+          :min_value => 1
+        }.merge(opts)
+        count = @proc.get_an_int(count_str, int_opts)
+        return unless count
+        # step 1 is core.step_count = 0 or "stop next event"
+        step_count = count - 1  
+      end
+    end
+    @proc.step(step_count, opts, condition)
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+  p cmd.run([name])
+end

data/processor/command/stepi.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/cmd'
+require_relative '../../app/condition'
+class Trepan::Command::StepICommand < Trepan::Command
+
+  unless defined?(HELP)
+    HELP =
+"stepi
+
+Step by VM instruction(s).
+
+Examples: 
+  stepi        # step 1 instruction
+  stepi 1      # same as above
+
+Related and similar is the 'step', 'next' (step over) and 'finish' (step out)
+commands.  All of these are slower than running to a breakpoint.
+
+See also the commands:
+'skip', 'jump' (there's no 'hop' yet), 'continue', 'return' and
+'finish' for other ways to progress execution.
+"
+
+    CATEGORY     = 'running'
+    NAME         = File.basename(__FILE__, '.rb')
+    NEED_RUNNING = true
+    SHORT_HELP   = 'Step VM instruction(s)'
+
+  end
+
+  include Trepan::Condition
+  # This method runs the command
+  def run(args) # :nodoc
+    opts = {:stop_events => Set.new(%w(insn))}
+    @proc.core.step_events |= Trace::INSN_EVENT_MASK
+    condition = nil
+    if args.size == 1
+      # Form is: "step" which means "step 1"
+      step_count = 0
+    else
+      count_str = args[1]
+      int_opts = {
+        :msg_on_error => 
+        "The 'step' command argument must eval to an integer. Got: %s" % 
+        count_str,
+        :min_value => 1
+      }.merge(opts)
+      count = @proc.get_an_int(count_str, int_opts)
+      return unless count
+      # step 1 is core.step_count = 0 or "stop next event"
+      step_count = count - 1  
+    end
+    @proc.step(step_count, opts, condition)
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+  p cmd.run([name])
+end

data/processor/command/unalias.rb

@@ -0,0 +1,44 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/cmd'
+
+class Trepan::Command::UnaliasCommand < Trepan::Command
+
+  unless defined?(HELP)
+    HELP = 
+"unalias COMMAND
+
+Remove alias for COMMAND
+
+See also 'alias'.
+"
+
+    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
+  
+  # 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'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+  cmd.run %w(unalias s)
+  cmd.run %w(unalias s)
+  cmd.run %w(unalias foo bar n)
+end

data/processor/command/undisplay.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/cmd'
+
+# undisplay display-number...
+class Trepan::Command::UndisplayCommand < Trepan::Command
+    
+  unless defined?(HELP)
+    HELP = <<EOH
+
+undisplay 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.
+Do "info display" to see current list of code numbers.
+EOH
+
+    ALIASES       = %w(und)
+    CATEGORY      = 'data'
+    NAME          = File.basename(__FILE__, '.rb')
+    NEED_STACK    = false
+    SHORT_HELP    = 'Cancel some expressions to be displayed when program stops'
+  end
+
+  def run(args)
+    
+    if args.size == 1
+      @proc.displays.clear
+      return
+    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
+      return false
+    end
+  end
+end
+
+if __FILE__ == $0
+  # demo it.
+  require 'thread_frame'
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+
+  def run_cmd(cmd, args)
+    cmd.run(args)
+    puts '==' * 10
+  end
+
+  cmd.proc.frame_setup(RubyVM::ThreadFrame::current)
+
+  run_cmd(cmd, %w(undisplay z))
+  run_cmd(cmd, %w(undisplay 1 10))
+end

data/processor/command/up.rb

@@ -0,0 +1,92 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'base/cmd'
+
+# up command. Like 'down' butthe direction (set by DIRECTION) is different.
+#
+# NOTE: The down command  subclasses this, so beware when changing! 
+class Trepan::Command::UpCommand < Trepan::Command
+
+  # Silence already initialized constant .. warnings
+  old_verbose = $VERBOSE  
+  $VERBOSE    = nil
+  HELP        = 
+"u(p) [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'.
+"
+
+  ALIASES       = %w(u)
+  CATEGORY      = 'stack'
+  MAX_ARGS      = 1  # Need at most this many
+  NAME          = File.basename(__FILE__, '.rb')
+  NEED_STACK    = true
+  SHORT_HELP    = 'Move frame in the direction of the caller of the last-selected frame'
+  $VERBOSE      = old_verbose 
+  
+  require_relative '../../app/frame'
+  include Trepan::Frame
+
+  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 not @proc.top_frame
+      errmsg('No frames recorded.')
+      return false
+    end
+
+    if args.size == 1
+      # Form is: "down" which means "down 1"
+      count = 1
+    else
+      stack_size = @proc.top_frame.stack_size - @proc.hide_level
+      count_str = args[1]
+      name_or_id = args[1]
+      opts = {
+        :msg_on_error => 
+        "The '#{NAME}' command argument requires a frame number. Got: %s" % count_str,
+        :min_value => -stack_size,
+        :max_value => stack_size-1
+      }
+      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 'thread_frame'
+  require_relative '../mock'
+  name = File.basename(__FILE__, '.rb')
+  dbgr, cmd = MockDebugger::setup(name)
+
+  def sep ; puts '=' * 40 end
+  cmd.run [name]
+  %w(-1 0 1 -2).each do |count| 
+    puts "#{name} #{count}"
+    cmd.run([name, count])
+    sep 
+  end
+  def foo(cmd, name)
+    cmd.proc.frame_setup(RubyVM::ThreadFrame::current)
+    puts "#{name}"
+    cmd.run([name])
+    sep
+    %w(-2 -1).each do |count| 
+      puts "#{name} #{count}"
+      cmd.run([name, count])
+      sep 
+    end
+  end
+  foo(cmd, name)
+end

data/processor/default.rb

@@ -0,0 +1,45 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../app/default'
+class Trepan
+  class CmdProcessor
+
+    DEFAULT_SETTINGS = {
+      :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
+      :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
+      :debugstack    => false,     # How hidden outer debugger stack frames
+      :directory     =>            # last-resort path-search for files
+                    '$cdir:$cwd',  # that are not fully qualified.
+
+      :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       => (ENV['COLUMNS'] || '80').to_i,
+      :prompt         => 'trepan', # core part of prompt. Additional info like
+                                   # debug nesting and 
+      :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(Trepanning::HOME_DIR, 'trepan', 'command'),
+                                   # User command directory
+    } unless defined?(DEFAULT_SETTINGS)
+  end
+end
+
+if __FILE__ == $0
+  # Show it:
+  require 'pp'
+  PP.pp(Trepan::CmdProcessor::DEFAULT_SETTINGS)
+end

data/processor/display.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../app/display'
+class Trepan
+  class CmdProcessor
+    attr_reader   :displays
+
+    def display_initialize
+      @displays = DisplayMgr.new
+    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,88 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+class Trepan
+  class CmdProcessor
+
+    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)
+      filename, b = get_binding_and_filename(str, max_fake_filename)
+      eval(str, b, 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 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
+    
+    def get_binding_and_filename(str, maxlen)
+      b = 
+        begin
+          @frame.binding
+        rescue
+          binding
+        end
+      filename = fake_eval_filename(str, maxlen)
+      return [filename, b]
+    end
+
+  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
+  begin 
+    1/0
+  rescue Exception => exc
+    cmdp.exception_dump(exc, true, $!.backtrace)
+    puts '=' * 40
+  end
+
+  x = 1
+  require 'thread_frame'
+  cmdp.instance_variable_set('@frame', RubyVM::ThreadFrame.current)
+  cmdp.instance_variable_set('@settings', {:stack_trace_on_error => true})
+  def cmdp.errmsg(mess) ; puts mess end
+  puts cmdp.debug_eval('x = "#{x}"')
+  puts cmdp.debug_eval('x+')
+  puts cmdp.debug_eval_no_errmsg('y+')
+  puts '=' * 40
+  puts cmdp.debug_eval('y = 1; x+', 4)
+  puts '=' * 40
+end