trepanning 0.1.6 → 1.93.32

data/processor/command/set.rb

@@ -6,17 +6,19 @@ class Trepan::Command::SetCommand < Trepan::SubcommandMgr
   unless defined?(HELP)
     NAME          = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
+**#{NAME}** [*set-subcommand*]
+
 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 "#{NAME}" for a list of "#{NAME}" subcommands and what they do.
-Type "help #{NAME} *" for just the list of "#{NAME}" 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 "#{NAME} auto..." is the
-same as "#{NAME} auto ...". For example "#{NAME} autolist" is the same 
-as "#{NAME} 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'
@@ -25,7 +27,7 @@ as "#{NAME} auto list".
   end
 
   def run(args)
-    if args.size > 1 
+    if args.size > 1
       first = args[1].downcase
       alen = 'auto'.size
       args[1..1] = ['auto', first[alen..-1]] if

data/processor/command/set_subcmd/confirm.rb

@@ -1,11 +1,24 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
 
 class Trepan::Subcommand::SetConfirm < Trepan::SetBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP = "Set whether to confirm potentially dangerous operations."
+    HELP = <<-EOH
+**#{PREFIX.join(' ')}**
+
+Some commands have drastic effects, so in interactive mode, we confirm
+these operations. Some commands have a ! suffix to disable that
+confirmation for that specific instance. This command enables or
+disables confirmation across *all* potentially dangerous commands,
+
+See also:
+---------
+
+`show confirm`
+EOH
+    SHORT_HELP = "Set whether to confirm potentially dangerous operations."
     IN_LIST    = true
     MIN_ABBREV = 'co'.size
   end

data/processor/command/set_subcmd/different.rb

@@ -6,9 +6,9 @@ class Trepan::Subcommand::SetDifferent < Trepan::SetBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = <<-EOH
-#{PREFIX.join(' ')} [on|off|nostack]
+**#{PREFIX.join(' ')}** [**on**|**off**|**nostack**]
 
-Set to make sure 'next' or 'step' moves to a new position.
+Set to make sure `next` or `step` moves to a new position.
 
 Due to the interpretive, expression-oriented nature of the Ruby
 Language and implementation, each line often may contain many possible
@@ -20,15 +20,17 @@ Setting 'different' to on will cause each 'step' or 'next' command to
 stop at a different position.
 
 Note though that the notion of different does take into account stack
-nesting. So in ARGV.map {|arg| arg.to_i} you get a stop before ARGV as
-well as one in the block. 
+nesting. So in `ARGV.map {|arg| arg.to_i}` you get a stop before ARGV as
+well as one in the block.
 
 If you to ignore stopping at added nesting levels, there are two
 possibilities. 'set step nostack' will ignore stack nestings levels on
 a given line. Also you can use 'next', but that also stepping into
 functions on different lines to also be skipped.
 
-See also 'step', 'next' which have suffixes '+' and '-' which
+See also:
+---------
+`step`, `next`' which have suffixes '+' and '-' and which
 override this setting.
     EOH
 

data/processor/command/set_subcmd/highlight.rb

@@ -1,11 +1,22 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
 
 class Trepan::Subcommand::SetHighlight < Trepan::SetBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP       = 'Set whether we use terminal highlighting'
+    HELP = <<-EOH
+**#{PREFIX.join(' ')}** [**on**|**off**]
+
+Set whether we use terminal highlighting.
+
+See also:
+---------
+
+`show highlight`
+
+EOH
+    SHORT_HELP       = 'Set whether we use terminal highlighting'
     IN_LIST    = true
     MIN_ABBREV = 'hi'.size
   end
@@ -17,7 +28,7 @@ class Trepan::Subcommand::SetHighlight < Trepan::SetBoolSubcommand
   def run(args)
     if args.size == 3 && 'reset' == args[2]
       LineCache::clear_file_format_cache
-      @proc.settings[:highlight] = :term 
+      @proc.settings[:highlight] = :term
     else
       super
       @proc.settings[:highlight] = :term if @proc.settings[:highlight]

data/processor/command/set_subcmd/pc.rb

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2012 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::SetPc < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = 'set PC INTEGER-EXPRESSION
+
+Set VM program-counter register (PC) to INTEGER-EXPRESSION.
+
+Warning: this is potentially dangerous.
+'
+    SHORT_HELP   = 'Set VM program counter (PC)'
+    IN_LIST      = true
+    MIN_ABBREV   = 'pc'.size
+  end
+
+  def run(args)
+    # FIXME handle c-return
+    # unless %w(return c-return).member?(@proc.event)
+    if args.size < 3
+      errmsg "Too few arguments - the 'pc' command requires a value"
+      return
+    end
+    new_val_str = args[2..-1].join(' ')
+    begin
+      new_val = @proc.debug_eval(new_val_str)
+    rescue StandardError, ScriptError => e
+      return
+    end
+    msg("Old value was: %s" % @proc.frame.pc_offset.inspect)
+    @proc.frame.pc_offset =  new_val
+    msg("New value is: %s" % new_val.inspect)
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative %w(.. .. mock)
+  require_relative %w(.. .. subcmd)
+  name = File.basename(__FILE__, '.rb')
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('set')
+  subcommand = Debugger::Subcommand::SetPc.new(cmd)
+  testcmdMgr = Debugger::Subcmd.new(subcommand)
+
+  def subcommand.msg(message)
+    puts message
+  end
+  def subcommand.msg_nocr(message)
+    print message
+  end
+  def subcommand.errmsg(message)
+    puts message
+  end
+  subcommand.run(%w(20))
+  name = File.basename(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/set_subcmd/sp.rb

@@ -1,11 +1,17 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2012 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
 
 class Trepan::Subcommand::SetSp < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP         = 'Set a stack pointer register'
+    HELP         = 'set sp INTEGER-EXPRESSION
+
+Set VM stack-pointer register (SP) to INTEGER-EXPRESSION.
+
+Warning: this is potentially dangerous.
+'
+    SHORT_HELP   = 'Set a stack pointer register'
     IN_LIST      = true
     MIN_ABBREV   = 'sp'.size
   end

data/processor/command/shell.rb

@@ -9,31 +9,33 @@ class Trepan::Command::IRBCommand < Trepan::Command
     require_relative '../../app/irb'
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [-d]
+**#{NAME}** [**-d**]
 
 Start an Interactive Ruby (IRB) session.
 
-If -d is added you can get access to debugger frame the global variables
-$trepan_frame and $trepan_cmdproc. 
+If `-d` is added, you can get access to debugger frame the global
+variables `$trepan_frame` and `$trepan_cmdproc`.
 
-#{NAME} is extended with methods 'cont', 'ne', and, 'q', 'step' which 
-run the corresponding debugger commands 'continue', 'next', 'exit' and 'step'. 
+#{NAME} is extended with methods `cont`, `ne`, `q`, and `step` which
+run the corresponding debugger commands: `continue`, `next`, `exit`
+and `step`.
 
 To issue a debugger command, inside #{NAME} nested inside a debugger use
 'dbgr'. For example:
 
-  dbgr %w(info program)
-  dbgr('info', 'program') # Same as above
-  dbgr 'info program'     # Single quoted string also works
+    dbgr %w(info program)
+    dbgr('info', 'program') # Same as above
+    dbgr 'info program'     # Single quoted string also works
 
 But arguments have to be quoted because #{NAME} will evaluate them:
 
-  dbgr info program     # wrong!
-  dbgr info, program    # wrong!
-  dbgr(info, program)   # What I say 3 times is wrong!
+    dbgr info program     # wrong!
+    dbgr info, program    # wrong!
+    dbgr(info, program)   # What I say 3 times is wrong!
 
 Here then is a loop to query VM stack values:
-  (-1..1).each {|i| dbgr(\"info reg sp \#{i}\")}
+
+    (-1..1).each {|i| dbgr(\"info reg sp \#{i}\")}
      HELP
 
     ALIASES    = %w(irb)
@@ -44,7 +46,7 @@ Here then is a loop to query VM stack values:
 
   # This method runs the command
   def run(args)
-    add_debugging = 
+    add_debugging =
       if args.size > 1
         '-d' == args[1]
       else
@@ -60,7 +62,7 @@ Here then is a loop to query VM stack values:
       throw :IRB_EXIT, :cont if $trepan_in_irb
     end
 
-    $trepan = @proc.dbgr 
+    $trepan = @proc.dbgr
     $trepan_cmdproc  = @proc
     if add_debugging
       $trepan_frame    = @proc.frame
@@ -73,32 +75,32 @@ Here then is a loop to query VM stack values:
             :RC => true}
 
     # ?? Should we set GNU readline to what we have,
-    # or let IRB make its own determination? 
+    # or let IRB make its own determination?
 
-    # Save the Readline history and set the Readline completion function 
-    # to be IRB's function 
-    if Trepan::GNU_readline? 
+    # Save the Readline history and set the Readline completion function
+    # to be IRB's function
+    if Trepan::GNU_readline?
       @proc.intf.save_history if @proc.intf.respond_to?(:save_history)
       require 'irb/completion'
       Readline.completion_proc = IRB::InputCompletor::CompletionProc
     end
 
-    # And just when you thought, we'd never get around to 
+    # And just when you thought, we'd never get around to
     # actually running irb...
     cont = IRB.start_session(@proc.frame.binding, @proc, conf)
     trap('SIGINT', save_trap) # Restore our old interrupt function.
 
-    # Restore the debuggers' Readline history and the Readline completion 
+    # Restore the debuggers' Readline history and the Readline completion
     # function
     if Trepan::GNU_readline? && @proc.dbgr.completion_proc
       @proc.intf.read_history if @proc.intf.respond_to?(:read_history)
-      Readline.completion_proc = @proc.dbgr.completion_proc 
+      Readline.completion_proc = @proc.dbgr.completion_proc
     end
 
     # Respect any backtrace limit set in irb.
     back_trace_limit = IRB.CurrentContext.back_trace_limit
     if settings[:maxstack] !=  back_trace_limit
-      msg("\nSetting debugger's BACK_TRACE_LIMIT (%d) to match irb's last setting (%d)" % 
+      msg("\nSetting debugger's BACK_TRACE_LIMIT (%d) to match irb's last setting (%d)" %
           [settings[:maxstack], back_trace_limit])
       settings[:maxstack]= IRB.CurrentContext.back_trace_limit
     end
@@ -107,7 +109,7 @@ Here then is a loop to query VM stack values:
     when :continue
       @proc.continue
     when :finish
-      @proc.finish 
+      @proc.finish
     when :next
       @proc.next # (1, {})
     when :quit

data/processor/command/show.rb

@@ -1,17 +1,19 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/submgr'
 
 class Trepan::Command::ShowCommand < Trepan::SubcommandMgr
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-'Generic command for showing things about the debugger.  You can
-give unique prefix of the name of a subcommand to get information
-about just that subcommand.
+**#{NAME}** [*show-subcommand*]
 
-Type "#{NAME}" for a list of "#{NAME}" subcommands and what they do.
-Type "help #{NAME} *" for just a list of "#{NAME}" subcommands.
+Generic command for showing things about the debugger.  You can
+give unique prefix of the name of a subcommand to get
+information about just that subcommand.
+
+Type `#{NAME}` for a list of *#{NAME}* subcommands and what they do.
+Type `help #{NAME} *` for just the list of `#{NAME}` subcommands.
     HELP
 
     CATEGORY      = 'status'
@@ -20,7 +22,7 @@ Type "help #{NAME} *" for just a list of "#{NAME}" subcommands.
   end
 
   def run(args)
-    if args.size > 1 
+    if args.size > 1
       first = args[1].downcase
       alen = 'auto'.size
       args[1..1] = ['auto', first[alen..-1]] if

data/processor/command/show_subcmd/confirm.rb

@@ -5,7 +5,18 @@ require_relative '../base/subcmd'
 class Trepan::Subcommand::ShowConfirm < Trepan::ShowBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP       = "Show confirm potentially dangerous operations setting"
+    HELP = <<-EOH
+**#{PREFIX.join(' ')}**
+
+Show confirm potentially dangerous operations setting.
+
+See also:
+---------
+
+`set confirm`
+EOH
+
+    SHORT_HELP  = "Show confirm potentially dangerous operations setting"
     MIN_ABBREV = 'co'.size
   end
 end

data/processor/command/show_subcmd/highlight.rb

@@ -1,17 +1,27 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subsubcmd'
 require_relative '../base/subsubmgr'
 
 class Trepan::Subcommand::ShowHighlight < Trepan::ShowBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP         = 'Show whether we use terminal highlighting'
+    HELP = <<-EOH
+**#{PREFIX.join(' ')}**
+
+Show whether we use terminal highlighting.
+
+See also:
+---------
+
+`set highlight`
+EOH
+    SHORT_HELP   = 'Show whether we use terminal highlighting'
     MIN_ABBREV   = 'high'.size
   end
 
   def run(args)
-    val = :term == @proc.settings[:highlight] 
+    val = :term == @proc.settings[:highlight]
     onoff = show_onoff(val)
     msg("%s is %s." % [@name, onoff])
   end

data/processor/command/source.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require 'optparse'
 
 # Our local modules
@@ -12,27 +12,28 @@ class Trepan::Command::SourceCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [options] FILE
+**#{NAME}** [*options*] *file*
+
+options:
 
-options: 
     -q | --quiet | --no-quiet
     -c | --continue | --no-continue
     -Y | --yes | -N | --no
     -v | --verbose | --no-verbose
 
-Read debugger commands from a file named FILE.  Optional -v switch
-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'.
+Read debugger commands from *file*. The optional `-v switch
+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".
 
-Option -q will turn off any debugger output that normally occurs in the
+Option `-q` will turn off any debugger output that normally occurs in the
 running of the program.
 
 Note that the command startup file #{Trepan::CMD_INITFILE_BASE} is read automatically
 via a #{NAME} command the debugger is started.
 
 An error in any command terminates execution of the command file
-unless option -c or --continue is given.
+unless option `-c` or `--continue` is given.
     HELP
     CATEGORY     = 'support'
     MIN_ARGS     = 1  # Need at least this many
@@ -52,35 +53,35 @@ unless option -c or --continue is given.
     files = Readline::FILENAME_COMPLETION_PROC.call(prefix) || []
     opts = %w(-c --continue --no-continue -N --no -y --yes
               --verbose --no-verbose) + files
-    Trepan::Complete.complete_token(opts, prefix) 
+    Trepan::Complete.complete_token(opts, prefix)
   end
-    
+
   def parse_options(options, args) # :nodoc
     seen_yes_no = false
     parser = OptionParser.new do |opts|
-      opts.on('-c', '--[no-]continue', 
+      opts.on('-c', '--[no-]continue',
               'Continue in the face of errors') do
-        |v| 
+        |v|
         options[:abort_on_error] = !v
       end
-      opts.on('-v', 
+      opts.on('-v',
               '--[no-]verbose', 'echo each command as it is executed') do
-        |v| 
+        |v|
         options[:verbose] = v
       end
       opts.on('-N', '--no', "Use 'no' in any confirmation prompts") do
-        |v| 
+        |v|
         if seen_yes_no
           msg('Yes/No option already seen. This option (no) ignored.')
         end
         options[:confirm_val] = false
       end
       opts.on('-q', '--[no-]quiet', 'Silence debugger output') do
-        |v| 
+        |v|
         options[:quiet] = v
       end
       opts.on('-Y', '--yes', "Use 'yes' in any confirmation prompts") do
-        |v| 
+        |v|
         if seen_yes_no
           msg("Yes/No option already seen. This option, --yes, ignored.")
         end
@@ -96,37 +97,37 @@ unless option -c or --continue is given.
     options = parse_options(DEFAULT_OPTIONS.dup, args[1..-2])
     intf = @proc.interfaces
     output  = options[:quiet] ? Trepan::OutputNull.new(nil) : intf[-1].output
-    
+
     filename = args[-1]
-    
+
     expanded_file = File.expand_path(filename)
     unless File.readable?(expanded_file)
-      errmsg("Debugger command file '%s' (%s) is not a readable file" % 
+      errmsg("Debugger command file '%s' (%s) is not a readable file" %
              [filename, expanded_file])
       return false
     end
-    
+
     # Push a new debugger interface.
     script_intf = Trepan::ScriptInterface.new(expanded_file, output, options)
     intf << script_intf
     return false
   end
 end
-  
+
 # Demo it
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
-  %w(--quiet -q --no-quiet --continue --no-continue -c -v --verbose 
+  %w(--quiet -q --no-quiet --continue --no-continue -c -v --verbose
      --no-verbose).each do |opt|
     puts "parsing #{opt}"
-    options = 
+    options =
       cmd.parse_options(Trepan::Command::SourceCommand::DEFAULT_OPTIONS.dup,
                         opt)
     p options
   end
 
-  if ARGV.size >= 1 
+  if ARGV.size >= 1
     puts "running... #{cmd.name} #{ARGV}"
     cmd.run([cmd.name, *ARGV])
   end