trepanning 0.0.4 → 0.0.6

data/processor/command/macro.rb

@@ -50,12 +50,11 @@ end
         
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
   cmdproc = dbgr.core.processor
-  ['macro foo Proc.new{|x, y| x+y}',
-   'macro bad x+1',
-   'macro bad2 1+2'].each do |cmdline|
+  ["#{cmd.name} foo Proc.new{|x, y| x+y}",
+   "#{cmd.name} bad x+1",
+   "#{cmd.name} bad2 1+2"].each do |cmdline|
     args = cmdline.split
     cmd_argstr = cmdline[args[0].size..-1].lstrip
     cmdproc.instance_variable_set('@cmd_argstr', cmd_argstr)

data/processor/command/next.rb

@@ -5,13 +5,14 @@ require_relative 'base/cmd'
 class Trepan::Command::NextCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-"next[+|=|-|<|>|!|<>] [EVENT-NAME...] [count]
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME}[+|=|-|<|>|!|<>] [EVENT-NAME...] [count]
 
 Step one statement ignoring steps into function calls at this level.
 Sometimes this is called 'step over'.
 
-With an integer argument, perform 'next' that many times. However if
+With an integer argument, perform '#{NAME}' that many times. However if
 an exception occurs at this level, or we 'return' or 'yield' or the
 thread changes, we stop regardless of count.
 
@@ -24,29 +25,28 @@ If no suffix is given, the debugger setting 'different'
 determines this behavior.
 
 Examples: 
-  next        # next 1 event, *any* event 
-  next 1      # same as above
-  next+       # same but force stopping on a new line
-  next=       # same but force stopping on a new line a new frame added
-  next-       # same but force stopping on a new line a new frame added
-  next 5/5+0  # same as above
-  next line   # next using only line events
-  next call   # next using only call call events
-  next<>      # next using call return events at this level or below
-"
+  #{NAME}        # #{NAME} 1 event, *any* event 
+  #{NAME} 1      # same as above
+  #{NAME}+       # same but force stopping on a new line
+  #{NAME}=       # same but force stopping on a new line a new frame added
+  #{NAME}-       # same but force stopping on a new line a new frame added
+  #{NAME} 5/5+0  # same as above
+  #{NAME} line   # #{NAME} using only line events
+  #{NAME} call   # #{NAME} using only call call events
+  #{NAME}<>      # #{NAME} using call return events at this level or below
+    HELP
 
-    ALIASES      = %w(n next+ next- next< next> next<> next! n> n< n! n+ n- 
+    ALIASES      = %W(n #{NAME}+ #{NAME}- #{NAME}< #{NAME}> #{NAME}<> #{NAME}! n> n< n! n+ n- 
                       n<> n=)
     CATEGORY     = 'running'
     # execution_set = ['Running']
     MAX_ARGS     = 1   # Need at most this many. FIXME: will be eventually 2
-    NAME         = File.basename(__FILE__, '.rb')
     NEED_RUNNING = true
     SHORT_HELP   = 'Step program without entering called functions'
   end
 
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
     opts = @proc.parse_next_step_suffix(args[0])
     if args.size == 1
       # Form is: "next" which means "next 1"
@@ -55,7 +55,7 @@ Examples:
       count_str = args[1]
       opts = {
         :msg_on_error => 
-        "The 'next' command argument must eval to an integer. Got: %s" % 
+        "The '#{NAME}' command argument must eval to an integer. Got: %s" % 
         count_str,
         :min_value => 1
       }
@@ -70,9 +70,8 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  [%w(n 5), %w(next 1+2), %w(n foo)].each do |c|
+  dbgr, cmd = MockDebugger::setup
+  [%w(n 5), %W(#{cmd.name} 1+2), %w(n foo)].each do |c|
     dbgr.core.step_count = 0
     cmd.proc.leave_cmd_loop = false
     result = cmd.run(c)

data/processor/command/nocache.rb

@@ -15,7 +15,7 @@ class Trepan::Command::NoCacheCommand < Trepan::Command
   end
 
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
     if @proc.frame.iseq
       puts @proc.frame.iseq.disassemble
       count = @proc.frame.iseq.killcache
@@ -27,7 +27,6 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  cmd.run([name])
+  dbgr, cmd = MockDebugger::setup
+  cmd.run([cmd.name])
 end

data/processor/command/{print.rb → pr.rb}

@@ -2,22 +2,25 @@
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
 require_relative '../eval'
-class Trepan::Command::PrintCommand < Trepan::Command
+class Trepan::Command::PrCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-      "print EXPRESSION
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+      "#{NAME} EXPRESSION
 
 Print the value of the EXPRESSION. Variables accessible are those of the
 environment of the selected stack frame, plus globals. 
 
 If the length output string large, the first part of the value is
-shown and ... indicates it has been truncated."
+shown and ... indicates it has been truncated.
+
+See 'set max string' to change the string truncation limit.
+    HELP
 
     # ALIASES       = %w(p)
     CATEGORY      = 'data'
-    NAME          = File.basename(__FILE__, '.rb')
-    SHORT_HELP    = 'Print expression'
+    SHORT_HELP    = 'print expression truncating long output'
   end
   
   def run(args)
@@ -27,11 +30,10 @@ end
         
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
   arg_str = '1 + 2'
   cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
-  cmd.run([name, arg_str])
+  cmd.run([cmd.name, arg_str])
   cmdproc = dbgr.core.processor
   cmds = dbgr.core.processor.commands
 end

data/processor/command/ps.rb

@@ -5,14 +5,15 @@ require_relative '../eval'
 class Trepan::Command::PsCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-      "ps ARRAY
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} ARRAY
 
-Print the value of the ARRAY in columns and sorted."
+Print the value of the ARRAY in columns and sorted.
+    HELP
 
     CATEGORY      = 'data'
     MIN_ARGS      = 1  # Need least this many
-    NAME          = File.basename(__FILE__, '.rb')
     SHORT_HELP    = 'Print array sorted and in columns'
   end
   
@@ -29,12 +30,11 @@ end
         
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
   arg_str = '(1..30).to_a'
   cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
-  cmd.run([name, arg_str])
+  cmd.run([cmd.name, arg_str])
   arg_str = '1'
   cmd.proc.instance_variable_set('@cmd_argstr', arg_str)
-  cmd.run([name, arg_str])
+  cmd.run([cmd.name, arg_str])
 end

data/processor/command/quit.rb

@@ -3,8 +3,11 @@ require_relative 'base/cmd'
 class Trepan::Command::QuitCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-      'quit[!] [unconditionally] [exit code] - gentle termination
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME}[!] [unconditionally] [exit code] 
+
+gentle termination
 
 The program being debugged is exited via exit() which runs the Kernel
 at_exit finalizers. If a return code is given, that is the return code
@@ -12,17 +15,17 @@ passed to exit() - presumably the return code that will be passed back
 to the OS. If no exit code is given, 0 is used.
 
 Examples: 
-  quit                 # quit prompting if we are interactive
-  quit conditionally   # quit without prompting
-  quit!                # same as above
-  quit 0               # same as "quit"
-  quit! 1              # unconditional quit setting exit code 1
+  #{NAME}                 # quit prompting if we are interactive
+  #{NAME} conditionally   # quit without prompting
+  #{NAME}!                # same as above
+  #{NAME} 0               # same as "quit"
+  #{NAME}! 1              # unconditional quit setting exit code 1
 
-See also the commands "exit" and "kill".'
+See also the commands "exit" and "kill".
+    HELP
 
-    ALIASES      = %w(quit! q q!)
+    ALIASES      = %W(#{NAME}! q q!)
     CATEGORY     = 'support'
-    NAME         = File.basename(__FILE__, '.rb')
     MAX_ARGS     = 2  # Need at most this many
     SHORT_HELP  = 'Quit program - gently'
   end
@@ -31,7 +34,7 @@ See also the commands "exit" and "kill".'
   # whether exit! or exit is used.
 
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
     unconditional = 
       if args.size > 1 && args[1] == 'unconditionally'
         args.shift
@@ -54,9 +57,8 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
+  dbgr, cmd = MockDebugger::setup
   name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  name = File.basename(__FILE__, '.rb')
-  fork { cmd.run([name]) }
-  cmd.run([name, '5'])
+  fork { cmd.run([cmd.name]) }
+  cmd.run([cmd.name, '5'])
 end

data/processor/command/raise.rb

@@ -3,19 +3,21 @@ require_relative 'base/cmd'
 class Trepan::Command::RaiseCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-"raise EXCEPTION
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} [exception-name]
 
-Raise an exception in the debugged program."
+Raise an EXCEPTION-NAME in the debugged program. If no exception name
+is given, raise RuntimeError.
+    HELP
 
     CATEGORY     = 'running'
     MAX_ARGS     = 1  # Need at most this many
-    NAME         = File.basename(__FILE__, '.rb')
     SHORT_HELP  = 'Raise an exception in the debugged program'
   end
     
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
     exception = 
       if args.size > 1
         except_str = args[1..-1].join(' ')
@@ -39,9 +41,8 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  puts cmd.run([name, 'NotanException'])
-  puts cmd.run([name, '[5]'])
-  puts cmd.run([name, 'RuntimeError'])
+  dbgr, cmd = MockDebugger::setup
+  puts cmd.run([cmd.name, 'NotanException'])
+  puts cmd.run([cmd.name, '[5]'])
+  puts cmd.run([cmd.name, 'RuntimeError'])
 end

data/processor/command/reload.rb

@@ -3,10 +3,10 @@
 require_relative 'base/submgr'
 
 class Trepan::Command::ReloadCommand < Trepan::SubcommandMgr
+  NAME          = File.basename(__FILE__, '.rb')
   ALIASES       = %w(rel)
   HELP = 'Reload information'
   CATEGORY      = 'data'
-  NAME          = File.basename(__FILE__, '.rb')
   NEED_STACK    = false
   SHORT_HELP    = 'Reload information'
   def initialize(proc)
@@ -17,12 +17,11 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
 
   # require 'trepanning'
   # Trepan.debug(:set_restart => true)
   xx = Trepan::Command::ReloadCommand.new(cmd)
-  cmd.run([name])
-  cmd.run([name, 'command'])
+  cmd.run([cmd.name])
+  cmd.run([cmd.name, 'command'])
 end

data/processor/command/restart.rb

@@ -5,19 +5,22 @@ require_relative '../../app/run'
 class Trepan::Command::RestartCommand < Trepan::Command
 
   unless defined?(HELP)
+    NAME         = File.basename(__FILE__, '.rb')
     ALIASES      = %w(R run)
-    HELP = 
-      'restart - Restart debugger and program via an exec
-    call. All state is lost, and new copy of the debugger is used.'
+    HELP = <<-HELP
+#{NAME} 
+
+Restart debugger and program via an exec call. All state is lost, and
+new copy of the debugger is used.
+    HELP
     
     CATEGORY     = 'running'
     MAX_ARGS     = 0  # Need at most this many
-    NAME         = File.basename(__FILE__, '.rb')
     SHORT_HELP  = '(Hard) restart of program via exec()'
   end
     
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
 
     dbgr = @proc.dbgr
     argv = dbgr.restart_argv
@@ -46,12 +49,10 @@ end
 
 if __FILE__ == $0
   exit if ARGV[0] == 'exit'
-
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
   dbgr.restart_argv = []
-  cmd.run([name])
+  cmd.run([cmd.name])
   dbgr.restart_argv = [File.expand_path($0), 'exit']
-  cmd.run([name])
+  cmd.run([cmd.name])
 end

data/processor/command/save.rb

@@ -4,17 +4,21 @@ require_relative 'base/cmd'
 class Trepan::Command::SaveCommand < Trepan::Command
 
   unless defined?(HELP)
-    HELP = 
-"Save settings to a file"
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} [filename]
+
+Save settings to file FILENAME. If FILENAME not given one will be made
+selected.
+    HELP
 
     CATEGORY     = 'running'
     MAX_ARGS     = 1  # Need at most this many
-    NAME         = File.basename(__FILE__, '.rb')
     SHORT_HELP  = 'Send debugger state to a file'
   end
     
   # This method runs the command
-  def run(args) # :nodoc
+  def run(args)
     save_filename = 
       if args.size > 1
         args[1]
@@ -51,10 +55,9 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
+  dbgr, cmd = MockDebugger::setup
   require 'tmpdir'
-  cmd.run([name, Dir.tmpdir])
-  cmd.run([name])
-  cmd.run([name, File.join(Dir.tmpdir, 'save_file.txt')])
+  cmd.run([cmd.name, Dir.tmpdir])
+  cmd.run([cmd.name])
+  cmd.run([cmd.name, File.join(Dir.tmpdir, 'save_file.txt')])
 end

data/processor/command/set.rb

@@ -4,22 +4,22 @@ require_relative 'base/submgr'
 
 class Trepan::Command::SetCommand < Trepan::SubcommandMgr
   unless defined?(HELP)
-    HELP =
-'Modifies parts of the debugger environment.
+    NAME          = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+Modifies parts of the debugger environment.
 
 You can give unique prefix of the name of a subcommand to get
 information about just that subcommand.
 
-Type "set" for a list of "set" subcommands and what they do.
-Type "help set *" for just the list of "set" subcommands.
+Type "#{NAME}" for a list of "#{NAME}" subcommands and what they do.
+Type "help #{NAME} *" for just the list of "#{NAME}" subcommands.
 
-For compatability with older ruby-debug "set auto..." is the
-same as "set auto ...". For example "set autolist" is the same 
-as "set auto list".
-'
+For compatability with older ruby-debug "#{NAME} auto..." is the
+same as "#{NAME} auto ...". For example "#{NAME} autolist" is the same 
+as "#{NAME} auto list".
+    HELP
 
     CATEGORY      = 'support'
-    NAME          = File.basename(__FILE__, '.rb')
     NEED_STACK    = false
     SHORT_HELP    = 'Modify parts of the debugger environment'
   end
@@ -38,10 +38,9 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  cmd.run([name])
-  cmd.run([name, 'autolist'])
-  cmd.run([name, 'autoeval', 'off'])
-  cmd.run([name, 'basename'])
+  dbgr, cmd = MockDebugger::setup
+  cmd.run([cmd.name])
+  cmd.run([cmd.name, 'autolist'])
+  cmd.run([cmd.name, 'autoeval', 'off'])
+  cmd.run([cmd.name, 'basename'])
 end