trepanning 1.93.35 → 2.15.33

data/processor/command/delete.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010-2012 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2012, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 require_relative '../breakpoint'
 require_relative '../../app/breakpoint'
@@ -8,26 +8,35 @@ class Trepan::Command::DeleteCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [bpnumber [bpnumber...]]  
+**#{NAME}** [*bpnumber* [*bpnumber*...]]
 
 Delete some breakpoints.
 
 Arguments are breakpoint numbers with spaces in between.  To delete
-all breakpoints, give no argument.  those breakpoints.  Without
-argument, clear all breaks (but first ask confirmation).
-    
-See also the "clear" command which clears breakpoints by line/file
-number.
+all breakpoints, give no argument. When deleting all breakpoints
+confirmation is asked for, unless the command is suffixed with "!".
+
+Examples:
+
+    delete 1   # delete breakpoint 1
+    delete     # delete all breakpoints
+    delete!    # Same as above, no questions asked.
+
+See also:
+---------
+
+The `clear` command clears breakpoints by line/file number; `set confirm`
+sets whether we confirm potentially destructive operations like this.
     HELP
 
     CATEGORY      = 'breakpoints'
     SHORT_HELP    = 'Delete some breakpoints'
-    ALIASES       = %w(d)
+    ALIASES       = %w(d d! delete!)
   end
-  
+
   def run(args)
     if args.size == 1
-      if confirm('Delete all breakpoints?', false)
+      if args[0][-1] == '!' or confirm('Delete all breakpoints?', false)
         @proc.brkpts.reset
         return
       end
@@ -36,14 +45,14 @@ number.
     args.each do |num_str|
       opts = {:msg_on_error => '%s must be a number' % num_str}
       i = @proc.get_an_int(num_str, opts)
-      if i 
+      if i
         success = @proc.delete_breakpoint_by_number(num_str.to_i, false) if i
         msg('Deleted breakpoint %d.' % i) if success
       end
     end
   end
 end
-        
+
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup

data/processor/command/directory.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 class Trepan::Command::DirectoryCommand < Trepan::Command
 
@@ -8,25 +8,27 @@ class Trepan::Command::DirectoryCommand < Trepan::Command
     MAX_ARGS     = 1  # Need at most this many
     NAME         = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [DIR]
+**#{NAME}** [*dir*]
 
-Add directory DIR to beginning of search path for source files.
-DIR can also be $cwd for the current working directory, or $cdir for the
-directory in which the debugged file start.
-With no argument, reset the search path to $cdir:$cwd, the default.
+Add directory *dir* to beginning of search path for source files.
+*dir* can also be `$cwd` for the current working directory, or `$cdir`
+for the directory in which the debugged file start.  With no argument,
+reset the search path to `$cdir:$cwd`, the default.
 
-This command may be useful if for some reason the debugger can't find 
-source files because directories have been moved. 
+This command may be useful if for some reason the debugger can't find
+source files because directories have been moved.
 
 Examples:
-   #{NAME} ~/.rvm/src/ruby-head  # Adds an rvm-like directory to path
-   #{NAME} # reset to $cdir:$cwd
+---------
+
+    #{NAME} ~/.rvm/src/ruby-head  # Adds an rvm-like directory to path
+    #{NAME} # reset to $cdir:$cwd
       HELP
 
-    SHORT_HELP  = 
-      'Add directory DIR to beginning of search path for source files'
+    SHORT_HELP  =
+      'Add directory *dir* to beginning of search path for source files'
   end
-    
+
   # This method runs the command
   def run(args) # :nodoc
     if args.size > 1

data/processor/command/disable.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_relative '../command'
 require_relative '../breakpoint'
 require_relative '../../app/breakpoint'
@@ -9,29 +9,32 @@ require_relative '../../app/util'
 # parameter to @proc.en_disable_breakpoint_by_number is different (set
 # as ENABLE_PARM below).
 #
-# NOTE: The enable command  subclasses this, so beware when changing! 
+# NOTE: The enable command  subclasses this, so beware when changing!
 class Trepan::Command::DisableCommand < Trepan::Command
 
   Trepan::Util.suppress_warnings {
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [display] NUM1 [NUM2 ...]
+**#{NAME}** [*display*] *num1* [*num2* ...]
 
 Disables the breakpoints or display given as a space separated list of
-numbers. 
+numbers.
 
-See also "enable" and "info break".
+See also:
+---------
+
+`enable` and `info break`.
   HELP
-    
+
     CATEGORY      = 'breakpoints'
     SHORT_HELP    = 'Disable some breakpoints or displays'
   }
 
   def initialize(proc)
     super
-    @enable_parm = false # true if enable 
+    @enable_parm = false # true if enable
   end
-  
+
   def run(args)
     if args.size == 1
       errmsg('No breakpoint or display number given.')
@@ -54,7 +57,7 @@ See also "enable" and "info break".
     end
   end
 end
-        
+
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup

data/processor/command/disassemble.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_relative '../command'
 require_relative '../../app/disassemble'
 require_relative '../../app/file'
@@ -8,12 +8,12 @@ class Trepan::Command::DisassembleCommand < Trepan::Command
     include Trepan::Disassemble
     include Trepanning
 
-  unless defined?(HELP)
-    NAME = File.basename(__FILE__, '.rb')
-    ALIASES       = %w(disasm) # Note we have disable
-    CATEGORY      = 'data'
-    HELP          = <<-HELP
-#{NAME} [thing] [full]
+    unless defined?(HELP)
+        NAME = File.basename(__FILE__, '.rb')
+        ALIASES       = %w(disasm) # Note we have disable
+        CATEGORY      = 'data'
+        HELP          = <<-HELP
+**#{NAME}** [*thing*] [**full**]
 
 With no argument, disassemble the current frame.  With a method,
 disassemble that method. '.' can be used to indicate the instruction
@@ -25,83 +25,89 @@ instruction sequence might have. If 'full' is given, all instruction
 sequences are include.
 
 Examples:
-  #{NAME} 
-  #{NAME} .       # Same as above
-  #{NAME} . full  # At least the instruction sequence above but maybe more
-  #{NAME} require_relative # disassemble method 'require_relative'
+---------
+
+    #{NAME}
+    #{NAME} .       # Same as above
+    #{NAME} . full  # At least the instruction sequence above but maybe more
+    #{NAME} require_relative # disassemble method 'require_relative'
+
+See also:
+---------
+
+`list`
     HELP
 
-    NEED_STACK    = true
-    SHORT_HELP    = 'Disassemble Ruby VM instructions'
-  end
+        NEED_STACK    = true
+        SHORT_HELP    = 'Disassemble Ruby VM instructions'
+    end
 
-  completion %w(. full)
+    completion %w(. full)
 
-  # FIXME: put in processor/data.rb? 
+    # FIXME: put in processor/data.rb?
 
-  def marked_disassemble(iseq_param, include_children)
-    iseqs = include_children ? iseq_param.child_iseqs : [iseq_param]
-    iseqs.each do |iseq|
-      ary = mark_disassembly(iseq.disasm_nochildren, 
-                             @proc.frame.iseq.equal?(iseq),
-                             @proc.frame.pc_offset,
-                             iseq.brkpts, settings[:maxwidth], 
-                             settings[:highlight])
-      msg ary
+    def marked_disassemble(iseq_param, include_children)
+        iseqs = include_children ? iseq_param.child_iseqs : [iseq_param]
+        iseqs.each do |iseq|
+            ary = mark_disassembly(iseq.disasm_nochildren,
+                                   @proc.frame.iseq.equal?(iseq),
+                                   @proc.frame.pc_offset,
+                                   iseq.brkpts, settings[:maxwidth],
+                                   settings[:highlight])
+            msg ary
+        end
     end
-  end
-
-  # Run command. 
-  def run(args)
-
-    obj = nil
-    include_children = 
-      if args.size > 1 && args[-1] == 'full'
-        args.pop
-        true
-      else
-        false
-      end
-    if args.size == 1 || '.' == args[1]
-      # Form is: "disassemble" or "disassemble ."
-      if @proc.frame.type == 'CFUNC'
-        errmsg "Can't handle C functions yet."
-        return
-      elsif @proc.frame.iseq
-        marked_disassemble(@proc.frame.iseq, include_children)
-        return
-      end
-    else 
-      if !(matches = find_iseqs(ISEQS__, args[1])).empty?
-        # FIXME: do something if there is more than one
-        iseq = matches[0]
-      else        
-        iseq = @proc.object_iseq(args[1])
-      end
-      marked_disassemble(iseq, include_children) if iseq
-      return
+
+    # Run command.
+    def run(args)
+
+        obj = nil
+        include_children =
+            if args.size > 1 && args[-1] == 'full'
+                args.pop
+                true
+            else
+                false
+            end
+        if args.size == 1 || '.' == args[1]
+            # Form is: "disassemble" or "disassemble ."
+            if @proc.frame.type == 'CFUNC'
+                errmsg "Can't handle C functions yet."
+                return
+            elsif @proc.frame.iseq
+                marked_disassemble(@proc.frame.iseq, include_children)
+                return
+            end
+        else
+            if !(matches = find_iseqs(ISEQS__, args[1])).empty?
+                # FIXME: do something if there is more than one
+                iseq = matches[0]
+            else
+                iseq = @proc.object_iseq(args[1])
+            end
+            marked_disassemble(iseq, include_children) if iseq
+            return
+        end
+        errmsg("Sorry can't handle right now.")
     end
-    errmsg("Sorry can't handle right now.")
-  end
 end
 
 if __FILE__ == $0
-  # Demo it.
-  require 'thread_frame'
+    # Demo it.
 
-  require_relative '../mock'
-  dbgr, cmd = MockDebugger::setup
-  def small_fn(cmd, name)
+    require_relative '../mock'
+    dbgr, cmd = MockDebugger::setup
+    def small_fn(cmd, name)
+        cmd.proc.frame_setup(RubyVM::Frame::current)
+        cmd.run [name]
+    end
+    small_fn(cmd, cmd.name)
+    p = Proc.new do
+        |x,y| x + y
+    end
     cmd.proc.frame_setup(RubyVM::Frame::current)
-    cmd.run [name]
-  end
-  small_fn(cmd, cmd.name)
-  p = Proc.new do 
-    |x,y| x + y
-  end
-  cmd.proc.frame_setup(RubyVM::Frame::current)
-  cmd.run([cmd.name, 'p'])
-  puts cmd.complete('f')
-  require 'irb'
-  cmd.run([cmd.name, 'IRB.start'])
+    cmd.run([cmd.name, 'p'])
+    puts cmd.complete('f')
+    require 'irb'
+    cmd.run([cmd.name, 'IRB.start'])
 end

data/processor/command/display.rb

@@ -1,17 +1,17 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 
 class Trepan::Command::DisplayCommand < Trepan::Command
-  
+
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{name} [format] EXP
- 
-Print value of expression EXP each time the program stops.  FMT may be
-used before EXP and may be one of 'c' for char, 'x' for hex, 'o' for
-octal, 'f' for float or 's' for string.
+**#{name}** [*format*] *expression*
+
+Print value of expression *expression* each time the program stops;
+*format* may be used to specify how to pring and may be one of 'c' for
+char, 'x' for hex, 'o' for octal, 'f' for float or 's' for string.
 
 For now, display expressions are only evaluated when in the same
 instruction sequence as the frame that was in effect when the display
@@ -20,12 +20,15 @@ more flexibility in the future to specify whether this should be the
 case or not.
 
 With no argument, evaluate and display all currently requested
-auto-display expressions.  Use "undisplay" to cancel display
+auto-display expressions.  Use `undisplay` to cancel display
 requests previously made.
 
-See also "undisplay", "enable", and "disable".
+See also:
+---------
+
+`undisplay`, `enable`, and `disable`.
     HELP
-    
+
   CATEGORY      = 'data'
   NEED_STACK    = false
   SHORT_HELP    = 'Display expressions when entering debugger'
@@ -37,7 +40,7 @@ end
 #end
 
 def run(args)
-  
+
   if args.size == 1
     # Display anything active
     @proc.run_eval_display
@@ -53,7 +56,7 @@ def run(args)
       format = nil
       expr = args[1..-1].join(' ')
     end
-    
+
     dp = @proc.displays.add(@proc.frame, expr, format)
     unless dp
       errmsg('Error evaluating "%s" in the current frame' % expr)

data/processor/command/down.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010, 2011, 2013 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2013, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'up'
 
 # Debugger "down" command. Is the same as the "up" command with the
@@ -10,12 +10,17 @@ class Trepan::Command::DownCommand < Trepan::Command::UpCommand
     old_verbose = $VERBOSE
     $VERBOSE    = nil
     HELP = <<-HELP
-#{NAME} [count]
+**#{NAME}** [*count*]
 
 Move the current frame down in the stack trace (to a newer frame). 0
 is the most-recent frame. If no count is given, move down 1.
 
-See also 'up' and 'frame'.
+A negative number moves in the opposite direction.
+
+See also:
+---------
+
+`up` and `frame`.
   HELP
 
     NAME          = File.basename(__FILE__, '.rb')

data/processor/command/edit.rb

@@ -1,27 +1,31 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative './../command'
 
 class Trepan::Command::EditCommand < Trepan::Command
 
-  old_verbose = $VERBOSE  
+  old_verbose = $VERBOSE
   $VERBOSE    = nil
   NAME        = File.basename(__FILE__, '.rb')
   HELP    = <<-HELP
-#{NAME} [[FILE] [LINE]]
+**#{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
+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
+---------
+
+    #{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)
@@ -29,30 +33,40 @@ Examples:
   NEED_STACK    = false
   SHORT_HELP    = 'Invoke an editor on some source code'
   MAX_ARGS      = 2
-  $VERBOSE      = old_verbose 
+  $VERBOSE      = old_verbose
 
   # FIXME: redo with locations and kparse.
   def run(args)
     case args.size
     when 1
-      file = @proc.frame.source_container[1]
-      line = @proc.frame.source_location[0]
+        if @proc.frame
+            file = @proc.frame.source_container[1]
+            line = @proc.frame.source_location[0]
+        else
+            errmsg("No Ruby program loaded.")
+            return
+        end
     when 2
-      line = Integer(args[1]) rescue nil
-      if line 
-        file = @proc.frame.source_container[1]
-      else 
+        line = Integer(args[1]) rescue nil
+        if line
+            if @proc.frame
+                file = @proc.frame.source_container[1]
+            else
+                errmsg("No Ruby program loaded.")
+                return
+            end
+      else
         file = args[1]
         line = 1
       end
     when 3
       line, file =  args[2], args[1]
     else
-      errmsg "edit needs at most 2 args." 
+      errmsg "edit needs at most 2 args."
     end
     editor = ENV['EDITOR'] || '/bin/ex'
     unless File.executable?(editor)
-      errmsg "Editor #{editor} is not executable. Trying anyway..." 
+      errmsg "Editor #{editor} is not executable. Trying anyway..."
     end
 
     if File.readable?(file)
@@ -71,7 +85,7 @@ 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'] 
+  cmd.run [cmd.name]
+  cmd.run [cmd.name, '7']
+  cmd.run [cmd.name, __FILE__, '10']
 end