trepanning 0.1.0 → 0.1.1

data/processor/command/condition.rb

@@ -20,6 +20,8 @@ made unconditional.
 Examples:
    #{NAME} 5 x > 10  # Breakpoint 5 now has condition x > 10
    #{NAME} 5         # Remove above condition
+
+See also "break", "enable" and "disable".
     HELP
 
     ALIASES       = %w(cond)

data/processor/command/continue.rb

@@ -1,13 +1,13 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
 require_relative '../running'
 require_relative '../../app/breakpoint' # FIXME: possibly temporary
-class Trepan::Command::ContinueCommand < Trepan::Command
 
+class Trepan::Command::ContinueCommand < Trepan::Command
   unless defined?(HELP)
-    NAME         = File.basename(__FILE__, '.rb')
+    NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [offset|line number]
+#{NAME} [LOCATION]
 
 Leave the debugger loop and continue execution. Subsequent entry to
 the debugger however may occur via breakpoints or explicit calls, or
@@ -21,32 +21,29 @@ Examples:
    #{NAME}
    #{NAME} 10    # continue to line 10
    #{NAME} o20   # continue to VM Instruction Sequence offset 20
+   #{NAME} gcd   # continue to first instruction of method gcd
+   #{NAME} IRB.start o7 # continue to IRB.start offset 7
+
+See also 'step', 'next', 'finish', 'nexti' commands and "help location".
     HELP
 
     ALIASES      = %w(c cont)
     CATEGORY     = 'running'
-    MAX_ARGS     = 1  # Need at most this many
+    MAX_ARGS     = 2  # Need at most this many
     NEED_RUNNING = true
-    SHORT_HELP   = 'Continue execution of debugged program'
+    SHORT_HELP   = 'Continue execution of the debugged program'
   end
 
-  # This method runs the command
+  # This is the method that runs the command
   def run(args)
     if args.size == 1
       # Form is: "continue"
       @proc.continue
     else
-      # FIXME: handle more general condition parameter rather than just
-      # a line number
-      position, iseq, use_offset, condition = 
-        @proc.breakpoint_position(args[1..-1])
-      return false unless position && iseq
-      bp = 
-        if use_offset
-          @proc.breakpoint_offset(position, iseq, true)
-        else
-          @proc.breakpoint_line(position, iseq, true)
-        end
+      iseq, line_number, vm_offset, condition, negate = 
+        @proc.breakpoint_position(@proc.cmd_argstr, false)
+      return false unless iseq && vm_offset
+      bp = @proc.breakpoint_offset(vm_offset, iseq, condition, negate)
       return unless bp
       @proc.continue
     end

data/processor/command/disassemble.rb

@@ -35,6 +35,8 @@ Examples:
     SHORT_HELP    = 'Disassemble Ruby VM instructions'
   end
 
+  completion %w(. full)
+
   # FIXME: put in processor/data.rb? 
 
   def marked_disassemble(iseq_param, include_children)
@@ -99,4 +101,7 @@ if __FILE__ == $0
   end
   cmd.proc.frame_setup(RubyVM::ThreadFrame::current)
   cmd.run([cmd.name, 'p'])
+  puts cmd.complete('f')
+  require 'irb'
+  cmd.run([cmd.name, 'IRB.start'])
 end

data/processor/command/down.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'up'
 
 # Debugger "down" command. Is the same as the "up" command with the 

data/processor/command/eval.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative './base/cmd'
+
+class Trepan::Command::EvalCommand < Trepan::Command
+
+  old_verbose = $VERBOSE  
+  $VERBOSE    = nil
+  NAME          = File.basename(__FILE__, '.rb')
+  HELP    = <<-HELP
+#{NAME} [STRING]
+
+Run code in the context of the current frame.
+
+The value of the expression is stored into a global variable so it
+may be used again easily. The name of the global variable is printed
+next to the inspect output of the value.
+
+If no string is given we run the string from the current source code
+about to be run. If the command ends ? (via an alias) and no string is
+given we will also strip off any leading 'if', 'while', 'elseif',
+'return', 'case', 'unless', or 'until' in the string.
+
+#{NAME} 1+2  # 3
+#{NAME} @v
+#{NAME}      # Run current source-code line
+#{NAME}?     # but strips off leading 'if', 'while', ..
+             # from command 
+
+See also 'set autoeval'. The command helps one predict future execution.
+See 'set buffer trace' for showing what may have already been run.
+      HELP
+
+  ALIASES       = %w(eval? ev? ev)
+  CATEGORY      = 'data'
+  NEED_STACK    = true
+  SHORT_HELP    = 'Run code in the current context'
+  $VERBOSE      = old_verbose 
+
+  def run(args)
+    if args.size == 1
+      text  = @proc.current_source_text
+      if  '?' == args[0][-1..-1] 
+        if text =~ /^\s*(?:if|elsif|unless)\s+/
+          text.gsub!(/^\s*(?:if|elsif|unless)\s+/,'') 
+          text.gsub!(/\s+then\s*$/, '')
+        elsif text =~ /^\s*(?:until|while)\s+/
+          text.gsub!(/^\s*(?:until|while)\s+/,'') 
+          text.gsub!(/\s+do\s*$/, '')
+        elsif text =~ /^\s*return\s+/
+          text.gsub!(/^\s*return\s+/,'')
+        elsif text =~ /^\s*case\s+/
+          text.gsub!(/^\s*case\s*/,'')
+        end
+        msg "eval: #{text}"
+      end
+    else
+      text = @proc.cmd_argstr
+    end
+    @proc.eval_code(text, settings[:maxstring])
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+  arg_str = '1 + 2'
+  cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
+  puts "eval #{arg_str} is: #{cmd.run([cmd.name, arg_str])}"
+end

data/processor/command/exit.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
 class Trepan::Command::ExitCommand < Trepan::Command
 
@@ -43,6 +43,9 @@ See also the commands "quit" and "kill".
     exitrc = (args.size > 1) ? exitrc = Integer(args[1]) rescue 0 : 0
     # No graceful way to stop threads...
     # A little harsh, but for now let's go with this.
+    # FIXME: Is this the best/most general way?
+    @proc.finalize
+    @proc.dbgr.intf[-1].finalize
     exit! exitrc
   end
 end

data/processor/command/finish.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
 
 class Trepan::Command::FinishCommand < Trepan::Command
@@ -9,8 +9,9 @@ class Trepan::Command::FinishCommand < Trepan::Command
     HELP = <<-HELP
 #{NAME} [levels]
 
-Continue execution until leaving the current function. 
-Sometimes this is called 'step out'.
+Continue execution until the program is about to leaving the current
+function or switch context via yielding or ending a block which was
+yield to. Sometimes this is called 'step out'.
 
 When `levels' is specified, that many frame levels need to be
 popped. The default is 1.  Note that 'yield' and exceptions raised my
@@ -24,6 +25,7 @@ one.
 See the break command if you want to stop at a particular point in a
 program. In general, '#{NAME}', 'step' and 'next' may slow a program down
 while 'break' will have less overhead.
+
     HELP
     ALIASES      = %w(fin)
     CATEGORY     = 'running'
@@ -54,7 +56,7 @@ while 'break' will have less overhead.
       # step 1 is core.level_count = 0 or "stop next event"
       level_count = count - 1  
     end
-    if 0 == level_count and %w(return c-return).member?(@proc.event)
+    if 0 == level_count and %w(return c-return yield leave).member?(@proc.event)
       errmsg "You are already at the requested return event."
     else
       @proc.finish(level_count, opts)

data/processor/command/frame.rb

@@ -46,15 +46,18 @@ See also 'up', 'down' 'where' and 'info thread'.
     SHORT_HELP    = 'Select and print a stack frame'
   end
   
+  def complete(prefix)
+    @proc.frame_complete(prefix, nil)
+  end
+  
   # The simple case: thread frame switching has been done or is
   # not needed and we have an explicit position number as a string
   def one_arg_run(position_str)
-    stack_size = @proc.top_frame.stack_size - @proc.hide_level
+    low, high = @proc.frame_low_high(nil)
     opts={
       :msg_on_error => 
       "The '#{NAME}' command requires a frame number. Got: #{position_str}",
-      :min_value => -stack_size,
-      :max_value => stack_size-1
+      :min_value => low, :max_value => high
     }
     frame_num = @proc.get_an_int(position_str, opts)
     return false unless frame_num

data/processor/command/help.rb

@@ -1,7 +1,7 @@
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
+require_relative '../../app/complete'
 class Trepan::Command::HelpCommand < Trepan::Command
-
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
@@ -32,25 +32,61 @@ See also 'examine' and 'whatis'.
     'running'     => 'Running the program', 
     'status'      => 'Status inquiries',
     'support'     => 'Support facilities',
-    'stack'       => 'Examining the call stack'
+    'stack'       => 'Examining the call stack',
+    'syntax'      => 'Debugger command syntax'
     }
     CATEGORY      = 'support'
     NEED_STACK    = false
     SHORT_HELP    = 'Print commands or give help for command(s)'
+
+    require 'thread_frame'
+    ROOT_DIR = File.dirname(RubyVM::ThreadFrame.current.source_container[1])
+    HELP_DIR      = File.join(ROOT_DIR, 'help')
+  end
+
+  def complete(prefix)
+    matches = Trepan::Complete.complete_token(CATEGORIES.keys + 
+                                              %w(* syntax all) + 
+                                          @proc.commands.keys, prefix)
+    aliases = Trepan::Complete.complete_token_filtered(@proc.aliases, prefix, 
+                                                       matches)
+    (matches + aliases).sort
+  end    
+
+  def complete(prefix)
+    matches = Trepan::Complete.complete_token(CATEGORIES.keys + %w(* all) + 
+                                              @proc.commands.keys, prefix)
+    aliases = Trepan::Complete.complete_token_filtered(@proc.aliases, prefix, 
+                                                       matches)
+    (matches + aliases).sort
+  end    
+
+  def complete_token_with_next(prefix)
+    complete(prefix).map do |cmd| 
+      [cmd, @proc.commands.member?(cmd) ? @proc.commands[cmd] : nil]
+      # complete_method = 
+      #   if 'syntax' == cmd
+      #     Syntax.new(syntax_files)
+      #   else
+      #     @proc.commands.member?(cmd) ? @proc.commands[cmd] : nil
+      #   end
+      # [cmd, complete_method]
+    end
   end
 
   # List the command categories and a short description of each.
   def list_categories
-    section 'Classes of commands:'
+    section 'Help classes:'
     CATEGORIES.keys.sort.each do |cat|
       msg("%-13s -- %s" % [cat, CATEGORIES[cat]])
     end
     final_msg = '
-Type "help" followed by a class name for a list of commands in that class.
-Type "help syntax" for information on debugger command syntax.
-Type "help *" for the list of all commands.
+Type "help" followed by a class name for a list of help items in that class.
+Type "help aliases" for a list of current aliases.
+Type "help macros" for a list of current macros.
+Type "help *" for the list of all commands, macros and aliases.
 Type "help all" for the list of all commands.
-Type "help REGEXP" for the list of commands matching /^#{REGEXP}/
+Type "help REGEXP" for the list of commands matching /^#{REGEXP}/.
 Type "help CLASS *" for the list of all commands in class CLASS.
 Type "help" followed by command name for full documentation.
 '
@@ -64,8 +100,14 @@ Type "help" followed by command name for full documentation.
       if cmd_name == '*'
         section 'All command names:'
         msg columnize_commands(@proc.commands.keys.sort)
+        show_aliases  unless @proc.aliases.empty?
+        show_macros unless @proc.macros.empty?
+      elsif cmd_name =~ /^aliases$/i
+        show_aliases
+      elsif cmd_name =~ /^macros$/i
+        show_macros
       elsif cmd_name =~ /^syntax$/i
-        show_command_syntax
+        show_command_syntax(args)
       elsif cmd_name =~ /^all$/i
         CATEGORIES.sort.each do |category|
           show_category(category[0], [])
@@ -90,6 +132,9 @@ Type "help" followed by command name for full documentation.
             msg "Aliases: #{cmd_obj.class.const_get(:ALIASES).join(', ')}"
           end
         end
+      elsif @proc.macros.member?(cmd_name)
+        msg "#{cmd_name} is a macro which expands to:"
+        msg "  #{@proc.macros[cmd_name]}", {:unlimited => true}
       else 
         matches = @proc.commands.keys.grep(/^#{cmd_name}/).sort rescue []
         if matches.empty?
@@ -104,9 +149,14 @@ Type "help" followed by command name for full documentation.
     end
   end
 
+  def show_aliases
+    section 'All alias names:'
+    msg columnize_commands(@proc.aliases.keys.sort)
+  end
+
   # Show short help for all commands in `category'.
   def show_category(category, args)
-      
+    
     if args.size == 1 && args[0] == '*'
       section "Commands in class %s:" % category
       
@@ -116,7 +166,7 @@ Type "help" followed by command name for full documentation.
       width = settings[:maxwidth]
       return columnize_commands(cmds)
     end
-        
+    
     msg('')
     section "Command class: %s" % category
     msg('')
@@ -125,52 +175,42 @@ Type "help" followed by command name for full documentation.
       msg("%-13s -- %s" % [name, @proc.commands[name].short_help])
     end
   end
+  
+  def syntax_files
+    @syntax_files ||= Dir.glob(File.join(HELP_DIR, '*.txt')).map do |txt| 
+      basename = File.basename(txt, '.txt')
+    end
+  end
+  
+  def show_command_syntax(args)
+    if args.size == 2
+      @syntax_summary_help ||= {}
+      section "List of syntax help"
+      syntax_files.each do |name|
+        @syntax_summary_help[name] ||= 
+          File.open(File.join(HELP_DIR, "#{name}.txt")).readline.chomp
+        msg "  %-8s -- %s" % [name, @syntax_summary_help[name]]
+      end
+    else
+      args[2..-1].each do |name|
+        if syntax_files.member?(name)
+          @syntax_help ||= {}
+          @syntax_help[name] = 
+            File.open(File.join(HELP_DIR, "#{name}.txt")).readlines[2..-1].join
+          section "Debugger syntax for a #{name}:"
+          msg @syntax_help[name]
+        else
+          errmsg "No syntax help for #{name}"
+        end
+      end
+    end
+  end
 
-  def show_command_syntax
-    section "Debugger command syntax"
-    msg <<-EOS
-Command command syntax is very simple-minded. 
-
-If a line starts with #, the command is ignored. 
-If a line starts with !, the line is eval'd. 
-
-If the command you want eval'd uses the Ruby ! initally, add that
-after the first !.
-
-Commands are split at whereever ;; appears. This process disregards
-any quotes or other symbols that have meaning in Ruby. The strings
-after the leading command string are put back on a command queue. 
-
-Within a single command, tokens are then white-space split. Again,
-this process disregards quotes or symbols that have meaning in Ruby.
-
-The first token is then looked up in the debugger command table and
-then the debugger alias table. If a match is found the command name
-and arguments are dispatched to the command object that process the
-command.
-
-If the command is not found and "auto eval" is set on, then the
-command is eval'd in the context that the program is currently stopped
-at. If "auto eval" is not set on, then we display an error message
-that the entered string is "undefined".
-
-If you want irb-like command-processing, it's possible to go into an
-irb shell with the "irb" command. It is also possible to arrange going
-into an irb shell every time you enter the debugger.
-
-Examples:
-
-# This line does nothing. It is a comment
-s    # by default, this is an alias for the "step" command
-!s   # shows the value of variable step. 
-!!s  # Evaluates !s (or "not s"). The first ! is indicates evaluate.
-info program;; list # Runs two commands "info program" and "list"
-pr  "hi ;;-)"  # Syntax error since ;; splits the line and " is not closed.
-!puts "hi ;;-)" # One way to do the above.
-
-See also "alias", "irb", "set auto eval", and "set auto irb".
-    EOS
+  def show_macros
+    section 'All macro names:'
+    msg columnize_commands(@proc.macros.keys.sort)
   end
+
 end
 
 if __FILE__ == $0
@@ -193,4 +233,7 @@ if __FILE__ == $0
   cmd.run %W(#{cmd.name} s.*)
   puts '=' * 40
   cmd.run %W(#{cmd.name} s<>)
+  puts '=' * 40
+  p cmd.complete('br')
+  p cmd.complete('un')
 end