trepanning 0.1.2 → 0.1.3

data/processor/command/enable.rb

@@ -12,10 +12,12 @@ class Trepan::Command::EnableCommand < Trepan::Command::DisableCommand
   $VERBOSE    = nil
   NAME        = File.basename(__FILE__, '.rb')
   HELP        = <<-HELP
-#{NAME} [display] bpnumber [bpnumber ...]
+#{NAME} [display] BPNUM1 [BPNUM2 ...]
     
-Enables the breakpoints given as a space separated list of breakpoint
-numbers. See also "info break" to get a list.
+Enables breakpoints BPNUM1. Breakpoints numbers are given as a space-
+separated list numbers. 
+
+See also "info break" to get a list of breakpoints.
   HELP
 
   ALIASES       = %w(en)

data/processor/command/eval.rb

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative './base/cmd'
+require_relative '../../app/util'
 
 class Trepan::Command::EvalCommand < Trepan::Command
 
@@ -16,10 +17,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
@@ -37,21 +50,23 @@ 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
       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
@@ -67,4 +82,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

@@ -53,6 +53,8 @@ end
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
+  puts "before #{cmd.name}"
   fork { cmd.run([cmd.name]) }
+  puts "before #{cmd.name} 10"
   cmd.run([cmd.name, '10'])
 end

data/processor/command/help.rb

@@ -44,15 +44,6 @@ See also 'examine' and 'whatis'.
     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)

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"

data/processor/command/help/examples.txt

@@ -0,0 +1,16 @@
+Command examples
+
+# This line does nothing. It is a comment. Useful in debugger command files.
+     # This line also does nothing. 
+s    # by default, this is an alias for the "step" command
+!s   # shows the value of variable "s".
+!!s  # Evaluates "!s" (or "not s"). The first ! is indicates evaluate.
+ !s  # Same as above, since there is a space in column one.
+
+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 "macro" "alias", "irb", "set auto eval", "set auto irb", "set
+abbrev", "info macro", and "show" variants of the above "set"
+commands.

data/processor/command/help/suffixes.txt

@@ -0,0 +1,17 @@
+Command suffixes which have special meaning
+
+Some commands like "step", or "list" do different things when an
+alias to the command ends in a particular suffix like ">". 
+
+Here are a list of commands and the special suffixes:
+
+command   suffix
+-------   ------
+list       >
+step       +,-,<,>
+next       +,-,<,> 
+quit       !
+kill       !
+eval       ?
+
+See help on the commands listed above for the specific meaning of the suffix.

data/processor/command/info.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/submgr'
 
 class Trepan::Command::InfoCommand < Trepan::SubcommandMgr

data/processor/command/info_subcmd/args.rb

@@ -8,10 +8,11 @@ class Trepan::Subcommand::InfoArgs < Trepan::Subcommand
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP         = 'Show argument variables of the current stack frame'
     MIN_ABBREV   = 'ar'.size 
+    MIN_ARGS     = 0
+    MAX_ARGS     = 0
     NEED_STACK   = true
   end
 
-  include Trepan::Frame
   def run(args)
     if 'CFUNC' == @proc.frame.type
       argc = @proc.frame.argc
@@ -23,12 +24,13 @@ class Trepan::Subcommand::InfoArgs < Trepan::Subcommand
         msg("No parameters in C call.")
       end
     else
-      param_names = all_param_names(@proc.frame.iseq, false)
+      param_names = Trepan::Frame::all_param_names(@proc.frame.iseq, false)
       if param_names.empty?
         msg("No parameters in call.")
       else
         param_names.each_with_index do |var_name, i|
-          var_value = @proc.safe_rep(@proc.debug_eval_no_errmsg(var_name).inspect)
+          var_value = 
+            @proc.safe_rep(@proc.debug_eval_no_errmsg(var_name).inspect)
           msg("#{var_name} = #{var_value}")
         end
         unless 'call' == @proc.event and 0 == @proc.frame_index
@@ -42,14 +44,6 @@ 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::InfoArgs.new(cmd)
-  testcmdMgr = Trepan::Subcmd.new(subcommand)
-
-  name = File.basename(__FILE__, '.rb')
-  subcommand.summary_help(name)
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoArgs, false)
+  cmd.run(cmd.prefix)
 end

data/processor/command/info_subcmd/breakpoints.rb

@@ -6,7 +6,7 @@ class Trepan::Subcommand::InfoBreakpoints < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP         = <<-EOH
-#{PREFIX.join(' ')} [num1 ...] [verbose]
+#{CMD} [num1 ...] [verbose]
 
 Show status of user-settable breakpoints. If no breakpoint numbers are
 given, the show all breakpoints. Otherwise only those breakpoints
@@ -90,7 +90,7 @@ EOH
       if args.size > 2
         opts = {
         :msg_on_error => 
-        "An '#{PREFIX.join(' ')}' argument must eval to a breakpoint between 1..#{@proc.brkpts.max}.",
+        "An '#{CMD}' argument must eval to a breakpoint between 1..#{@proc.brkpts.max}.",
         :min_value => 1,
         :max_value => @proc.brkpts.max
       }
@@ -124,6 +124,12 @@ EOH
           notfound.empty? 
       end
     end
+    if @proc.traced_vars.empty?
+      msg('No traced variables.')
+    else
+      section 'Traced Variables'
+      msg columnize_commands(@proc.traced_vars.keys.sort)
+    end
   end
 
 end

data/processor/command/info_subcmd/frame.rb

@@ -34,6 +34,8 @@ Frame basename
 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

data/processor/command/info_subcmd/globals.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'columnize'
+require_relative '../base/subcmd'
+require_relative '../../../app/frame'
+
+class Trepan::Subcommand::InfoGlobals < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = <<-EOH
+#{CMD}
+#{CMD} [names]
+
+Show global variables.
+Normally for each which show both the name and value. If you just
+want a list of names add parameter 'names'.
+EOH
+    SHORT_HELP   = 'Show global variables'
+    MIN_ARGS     = 0
+    MAX_ARGS     = 1
+    MIN_ABBREV   = 'gl'.size 
+    NEED_STACK   = true
+  end
+
+  def run(args)
+    if args.size == 3
+      if 0 == 'names'.index(args[-1].downcase)
+        if global_variables.empty?
+            msg "No global variables defined."
+        else
+          section "Global variable names:"
+          width = settings[:maxwidth]
+          mess = Columnize::columnize(global_variables.sort, 
+                                      @proc.settings[:maxwidth], '  ',
+                                      false, true, ' ' * 2).chomp
+          msg mess
+        end
+      else
+        errmsg("unrecognized argument #{args[2]}")
+      end
+    elsif args.size == 2
+      if global_variables.empty?
+        msg "No global variables defined."
+      else
+        section "Global variables:"
+        global_variables.sort.each do |var_name| 
+          s = @proc.debug_eval(var_name)
+          msg("#{var_name} = #{s.inspect}")
+        end
+      end
+    else
+      errmsg("Wrong number of arguments #{args.size}")
+    end
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoGlobals, false)
+  cmd.run(cmd.prefix)
+  cmd.run(cmd.prefix + ['name'])
+end

data/processor/command/info_subcmd/iseq.rb

@@ -9,7 +9,7 @@ class Trepan::Subcommand::InfoIseq < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = <<-EOH
-#{CMD} iseq [METHOD|.]
+#{CMD} [METHOD|.]
 
 Show information about an instruction sequence.
 
@@ -20,6 +20,8 @@ Examples:
   #{CMD} require_relative
   EOH
     MIN_ABBREV   = 'is'.size
+    MIN_ARGS     = 0
+    MAX_ARGS     = 1
     NEED_STACK   = true
     SHORT_HELP   = 'Information about an instruction sequence'
   end

data/processor/command/info_subcmd/locals.rb

@@ -7,13 +7,21 @@ require_relative '../../../app/frame'
 class Trepan::Subcommand::InfoLocals < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP         = 'Show local variables of the current stack frame'
+    HELP         = <<-EOH
+#{CMD}
+#{CMD} [names]
+
+Show local variables including parameters of the current stack frame.
+Normally for each which show both the name and value. If you just
+want a list of names add parameter 'names'.
+EOH
+    SHORT_HELP   = 'Show local variables of the current stack frame'
+    MIN_ARGS     = 0
     MAX_ARGS     = 1
     MIN_ABBREV   = 'lo'.size 
     NEED_STACK   = true
   end
 
-  include Trepan::Frame
   def get_local_names
     iseq = @proc.frame.iseq
     0.upto(iseq.local_size-2).map do
@@ -32,10 +40,10 @@ class Trepan::Subcommand::InfoLocals < Trepan::Subcommand
           if local_names.empty?
             msg "No local variables defined."
           else
-            msg "Local variable names:"
+            section "Local variable names:"
             width = settings[:maxwidth]
             mess = Columnize::columnize(local_names, 
-                                        @proc.settings[:maxwidth], ', ',
+                                        @proc.settings[:maxwidth], '  ',
                                         false, true, ' ' * 2).chomp
             msg mess
           end
@@ -58,7 +66,7 @@ class Trepan::Subcommand::InfoLocals < Trepan::Subcommand
         if local_names.empty?
           msg "No local variables defined."
         else
-          msg "Local variables:"
+          section "Local variables:"
           get_local_names.each_with_index do |var_name, i| 
             var_value = @proc.safe_rep(@proc.debug_eval_no_errmsg(var_name).inspect)
             msg("#{var_name} = #{var_value}")
@@ -74,14 +82,7 @@ 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::InfoLocals.new(cmd)
-  testcmdMgr = Trepan::Subcmd.new(subcommand)
-
-  name = File.basename(__FILE__, '.rb')
-  subcommand.summary_help(name)
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::InfoLocals, false)
+  cmd.run(cmd.prefix)
+  cmd.run(cmd.prefix + ['name'])
 end