rbx-trepanning 0.0.8-universal-rubinius-1.2 → 0.1.0-universal-rubinius-1.2

data/processor/command/display.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 
 class Trepan::Command::DisplayCommand < Trepan::Command
 
@@ -23,6 +23,8 @@ case or not.
 With no argument, evaluate and display all currently requested
 auto-display expressions.  Use "undisplay" to cancel display
 requests previously made.
+
+See also "undisplay", "enable", and "disable".
     HELP
     
     CATEGORY      = 'data'

data/processor/command/down.rb

@@ -7,10 +7,10 @@ require_relative 'up'
 # direction (set by DIRECTION) reversed.
 class Trepan::Command::DownCommand < Trepan::Command::UpCommand
 
-  # Silence already initialized constant .. warnings
-  old_verbose = $VERBOSE  
-  $VERBOSE    = nil
-  HELP = <<-HELP
+  Trepan::Util.suppress_warnings {
+    old_verbose = $VERBOSE  
+    $VERBOSE    = nil
+    HELP = <<-HELP
 #{NAME} [count]
 
 Move the current frame down in the stack trace (to a newer frame). 0
@@ -19,10 +19,10 @@ is the most recent frame. If no count is given, move down 1.
 See also 'up' and 'frame'.
   HELP
 
-  ALIASES       = %w(d)
-  NAME          = File.basename(__FILE__, '.rb')
-  SHORT_HELP    = 'Move frame in the direction of the caller of the last-selected frame'
-  $VERBOSE      = old_verbose 
+    ALIASES       = %w(d)
+    NAME          = File.basename(__FILE__, '.rb')
+    SHORT_HELP    = 'Move frame in the direction of the caller of the last-selected frame'
+  }
 
   def initialize(proc)
     super

data/processor/command/edit.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../command'
+
+class Trepan::Command::EditCommand < Trepan::Command
+
+  old_verbose = $VERBOSE  
+  $VERBOSE    = nil
+  NAME        = File.basename(__FILE__, '.rb')
+  HELP    = <<-HELP
+#{NAME} [[FILE] [LINE]]
+
+With no argument, edits file containing most recent line listed.
+The value of the environment variable EDITOR is used for the
+editor to run. If no EDITOR environment variable is set /bin/ex
+is used. The editor should support line and file positioning via
+   editor-name +line file-name
+(Most editors do.)
+
+Examples:
+#{NAME}            # Edit current location
+#{NAME} 7          # Edit current file at line 7
+#{NAME} test.rb    # Edit test.rb, line 1
+#{NAME} test.rb 10 # Edit test.rb  line 10
+      HELP
+
+  ALIASES       = %w(e)
+  CATEGORY      = 'files'
+  NEED_STACK    = false
+  SHORT_HELP    = 'Invoke an editor on some source code'
+  MAX_ARGS      = 2
+  $VERBOSE      = old_verbose 
+
+  # FIXME: redo with locations and kparse.
+  def run(args)
+    case args.size
+    when 1
+      file = @proc.frame.file
+      line = @proc.frame.line
+    when 2
+      line = Integer(args[1]) rescue nil
+      if line 
+        file = @proc.frame.file
+      else 
+        file = args[1]
+        line = 1
+      end
+    when 3
+      line, file =  args[2], args[1]
+    else
+      errmsg "edit needs at most 2 args." 
+    end
+    editor = ENV['EDITOR'] || '/bin/ex'
+    if File.readable?(file)
+      file = File.basename(file) if settings[:basename]
+      edit_cmd = "#{editor} +#{line} \"#{file}\""
+      msg "Running #{edit_cmd}..."
+      system(edit_cmd)
+      msg "Warning: return code was #{$?.exitstatus}" if $?.exitstatus != 0
+    else
+      errmsg "File \"#{file}\" is not readable."
+    end
+  end
+end
+
+if __FILE__ == $0
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+  ENV['EDITOR'] = 'echo FAKE-EDITOR'
+  cmd.run [cmd.name] 
+  cmd.run [cmd.name, '7'] 
+  cmd.run [cmd.name, __FILE__, '10'] 
+end

data/processor/command/enable.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative 'disable'
+
+# enable breakpoint command. Is like disable but the parameter
+# to @proc.en_disable_breakpoint_by_number is different (set as
+# ENABLE_PARM below).
+class Trepan::Command::EnableCommand < Trepan::Command::DisableCommand
+
+  Trepan::Util.suppress_warnings {
+    NAME        = File.basename(__FILE__, '.rb')
+    HELP        = <<-HELP
+#{NAME} [display] NUM1 [NUM2 ...]
+    
+Enables breakpoints or display NUM1. Breakpoints numbers are given as
+a space-separated list numbers.
+
+See also "disable" and "info break".
+  HELP
+    
+    ALIASES       = %w(en)
+    SHORT_HELP    = 'Enable some breakpoints'
+  }
+
+  def initialize(proc)
+    super
+    @enable_parm = true # true if enable 
+  end
+
+end
+        
+if __FILE__ == $0
+  require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
+  cmd.run([cmd.name])
+  cmd.run([cmd.name, '1'])
+  cmdproc = cmd.proc
+  cmds = cmdproc.commands
+  break_cmd = cmds['break']
+  break_cmd.run(['break', cmdproc.frame.source_location[0].to_s])
+  cmd.run([cmd.name, '1'])
+end

data/processor/command/eval.rb

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative './base/cmd'
+require_relative '../command'
+require_relative '../../app/util'
 
 class Trepan::Command::EvalCommand < Trepan::Command
 
@@ -17,10 +18,22 @@ 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
+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.
+given we will the following translations occur:
+
+   {if|elsif|unless} expr [then]  => expr
+   {until|while} expr [do]        => expr
+   return expr                    => expr
+   case expr                      => expr
+   def fn(params)                 => [params]
+   var = expr                     => expr
+
+The above is done via regular expression. No fancy parsing is done, say,
+to look to see if expr is split across a line or whether var an assigment
+might have multiple variables on the left-hand side.
+
+Examples:
 
 #{NAME} 1+2  # 3
 #{NAME} @v
@@ -38,21 +51,24 @@ See 'set buffer trace' for showing what may have already been run.
   SHORT_HELP    = 'Run code in the current context'
   $VERBOSE      = old_verbose 
 
+  def complete(prefix)
+    if prefix.empty? 
+      if @proc.leading_str.start_with?('eval?')
+        Trepan::Util.extract_expression @proc.current_source_text
+      else
+        @proc.current_source_text 
+      end
+    else
+      prefix
+    end
+  end
+
   def run(args)
     if args.size == 1
       text  = @proc.current_source_text
+      ## FIXME turn into a subroutine and use in complete.
       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
+        text = Trepan::Util::extract_expression(text)
         msg "eval: #{text}"
       end
     else
@@ -68,4 +84,10 @@ if __FILE__ == $0
   arg_str = '1 + 2'
   cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
   puts "eval #{arg_str} is: #{cmd.run([cmd.name, arg_str])}"
+  arg_str = 'return "foo"'
+  # def cmd.proc.current_source_text
+  #   'return "foo"'
+  # end
+  # cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
+  # puts "eval? #{arg_str} is: #{cmd.run([cmd.name + '?'])}"
 end

data/processor/command/exit.rb

@@ -1,13 +1,13 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 class Trepan::Command::ExitCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME         = File.basename(__FILE__, '.rb')
     ALIASES      = %w(quit q q! quit! exit!)
     HELP = <<-HELP
-#{NAME} [exitcode] - hard exit of the debugged program.  
+#{NAME} [exitcode] [unconditionally] - hard exit of the debugged program.  
 
 The program being debugged is exited via exit!() which does not run
 the Kernel at_exit finalizers. If a return code is given, that is the
@@ -18,6 +18,13 @@ If you are in interactive mode, and confirm is not set off, you are
 prompted to confirm quitting. However if you do not want to be
 prompted, add ! the end.  (vim/vi/ed users can use alias q!).
 
+Examples: 
+ #{NAME}                 # quit prompting if we are interactive
+ #{NAME} unconditionally # quit without prompting
+ #{NAME}!                # same as above
+ #{NAME} 0               # same as "quit"
+ #{NAME}! 1              # unconditional quit setting exit code 1
+
 See also "kill" and "set confirm".'
     HELP
 
@@ -32,7 +39,7 @@ See also "kill" and "set confirm".'
   # This method runs the command
   def run(args) # :nodoc
     unconditional = 
-      if args.size > 1 && args[1] == 'unconditionally'
+      if args.size > 1 && args[-1] == 'unconditionally'
         args.shift
         true
       elsif args[0][-1..-1] == '!'
@@ -44,7 +51,17 @@ See also "kill" and "set confirm".'
       msg('Quit not confirmed.')
       return
     end
-    exitrc = (args.size > 1) ? exitrc = Integer(args[1]) rescue 0 : 0
+    
+    if (args.size > 1)
+      if  args[1] =~ /\d+/
+        exitrc = args[1].to_i;
+      else
+        errmsg "Bad an Integer return type \"#{args[1]}\"";
+        return;
+      end
+    else
+      exitrc = 0
+    end
 
     # FIXME: Is this the best/most general way?
     @proc.finalize
@@ -59,6 +76,8 @@ end
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
-  fork { cmd.run([cmd.name]) }
+  Process.fork { cmd.run([cmd.name]) } if 
+    Process.respond_to?(:fork) 
+  cmd.run([cmd.name, 'foo'])
   cmd.run([cmd.name, '10'])
 end

data/processor/command/finish.rb

@@ -1,11 +1,13 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 
 class Trepan::Command::FinishCommand < Trepan::Command
 
   unless defined?(HELP)
+    ALIASES      = %w(fin finish+ fin+)
+    CATEGORY     = 'running'
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
 #{NAME}
@@ -28,9 +30,7 @@ Examples:
 See also commands:
 'continue', 'break', 'next', 'nexti', 'step' for other ways to continue.
     HELP
-    ALIASES      = %w(fin finish+ fin+)
-    CATEGORY     = 'running'
-    # execution_set = ['Running']
+    NEED_RUNNING = true
     MAX_ARGS     = 1   # Need at most this many. 
     NEED_STACK   = true
     SHORT_HELP   = 'Step to end of current method (step out)'

data/processor/command/frame.rb

@@ -1,5 +1,5 @@
 require 'rubygems'; require 'require_relative'
-require_relative './base/cmd'
+require_relative '../command'
 
 class Trepan::Command::FrameCommand < Trepan::Command
   CATEGORY     = 'stack'
@@ -59,7 +59,7 @@ See also 'up', 'down', and  'backtrace'.
     #   ## @proc.find_and_set_debugged_frame(frame, thread_id)
     end
 
-    stack_size = @proc.dbgr.vm_locations.size
+    stack_size = @proc.frame.stack_size
     if stack_size == 0
       errmsg('No frames recorded.')
       return false

data/processor/command/help.rb

@@ -1,6 +1,6 @@
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../../app/complete'
 class Trepan::Command::HelpCommand < Trepan::Command
   unless defined?(HELP)
@@ -21,8 +21,6 @@ Some commands like 'info', 'set', and 'show' can accept an
 additional subcommand to give help just about that particular
 subcommand. For example 'help info line' give help about the
 info line command.
-
-See also 'examine' and 'whatis'.
     HELP
 
     ALIASES       = %w(?)
@@ -76,10 +74,10 @@ 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 all" for a brief description of all commands.
 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.
+Type "help" followed by a command name for full documentation.
 '
     msg(final_msg)  
   end
@@ -102,6 +100,7 @@ Type "help" followed by command name for full documentation.
       elsif cmd_name =~ /^all$/i
         CATEGORIES.sort.each do |category|
           show_category(category[0], [])
+          msg('')
         end
       elsif CATEGORIES.member?(cmd_name)
         show_category(args[1], args[2..-1])
@@ -155,12 +154,11 @@ Type "help" followed by command name for full documentation.
         category == @proc.commands[cmd_name].category
       end.sort
       width = settings[:maxwidth]
-      return columnize_commands(cmds)
+      msg columnize_commands(cmds)
+      return 
     end
     
-    msg('')
     section "Command class: %s" % category
-    msg('')
     @proc.commands.keys.sort.each do |name|
       next if category != @proc.commands[name].category
       msg("%-13s -- %s" % [name, @proc.commands[name].short_help])
@@ -188,7 +186,7 @@ Type "help" followed by command name for full documentation.
           @syntax_help ||= {}
           @syntax_help[name] = 
             File.open(File.join(HELP_DIR, "#{name}.txt")).readlines[2..-1].join
-          section "Debugger syntax for a #{name}:"
+          section "Help for #{name}:"
           msg @syntax_help[name]
         else
           errmsg "No syntax help for #{name}"

data/processor/command/help/README

@@ -0,0 +1,10 @@
+Files in this directory are help for "help syntax". 
+
+A list of sub-names is obtained by Dir.glob('*.txt') in this
+directory.
+
+Each file name without the trailing ".txt' is the name of the help
+subcategory under "help syntax". 
+
+The first line in the file is a summary shown in help summary. 
+Lines 3 on are shown as help text.

data/processor/command/help/command.txt

@@ -1,11 +1,11 @@
-overall debugger command syntax
+Overall Debugger Command Syntax
 
-Command tokenization syntax is very simple-minded. 
+If the first non-blank character of a line starts with #, 
+the command is ignored. 
 
-If a line starts with #, the command is ignored. 
-If a line starts with !, the line is eval'd. 
+If a line starts with ! in column one, the line is eval'd. 
 
-If the command you want eval'd uses the Ruby ! initially, add that
+If the command you want Ruby to eval uses ! initially, add that
 after the first ! or start the line with a space.
 
 Commands are split at whereever ;; appears. This process disregards
@@ -18,31 +18,41 @@ Some commands like 'eval', 'macro', and 'break' have access to the
 untokenized string entered and make use of that rather than the
 tokenized list.
 
-The leading token is first looked up in the macro table. If it is in
-the table, the expansion is replaces the current command and possibly
-other commands pushed onto a command queue.  Next, the leading token is
-looked up in the debugger alias table and the name may be substituted
-there. Finally, the leading token is looked up in the debugger alias
-table. If a match is found, the command name and arguments are
-dispatched to the command object that process the command.
+Resolving a command name involves possibly 4 steps. Some steps may be
+omitted depending on early success or some debugger settings:
 
-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".
+1. The leading token is first looked up in the macro table. If it is in
+the table, the expansion is replaces the current command and possibly
+other commands pushed onto a command queue. See the "help macros" for
+help on how to define macros, and "info macro" for current macro
+definitions. 
+
+2. The leading token is next looked up in the debugger alias table and
+the name may be substituted there. See "help alias" for how to define
+aliases, and "show alias" for the current list of aliases.
+
+3. After the above, The leading token is looked up a table of debugger
+commands. If an exact match is found, the command name and arguments
+are dispatched to that command. Otherwise, we may check to see the the
+token is a unique prefix of a valid command. For example, "dis" is not
+a unique prefix because there are both "display" and "disable"
+commands, but "disp" is a unique prefix. You can allow or disallow
+abbreviations for commands using "set abbrev". The default is
+abbreviations are on.
+
+4. If after all of the above, we still don't find a command, the line
+may be evaluated as a Ruby statement in the current context of the
+program at the point it is stoppped. However this is done only if
+"autoeval" is on.  (It is on by default.)
+
+If "auto eval" is not set on, or if running the Ruby statement
+produces an error, 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".
+See also: 
+  "help syntax examples"
+  "help syntax suffix"