trepanning 0.1.6 → 1.93.32

data/processor/command/next.rb

@@ -1,5 +1,5 @@
 # -*- 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::NextCommand < Trepan::Command
@@ -7,36 +7,42 @@ class Trepan::Command::NextCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME}[+|=|-|<|>|!|<>] [EVENT-NAME...] [count]
+**#{NAME}**[+|=|-|<|>|!|<>] [*event-name*...] [*count*]
 
 Step one statement ignoring steps into function calls at this level.
-Sometimes this is called 'step over'.
+Sometimes this is called "step over".
 
-With an integer argument, perform '#{NAME}' that many times. However if
-an exception occurs at this level, or we 'return' or 'yield' or the
+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.
 
-A suffix of '+' on the command or an alias to the command forces to
-move to another line, while a suffix of '-' does the opposite and
+A suffix of "+" on the command or an alias to the command forces to
+move to another line, while a suffix of "-" does the opposite and
 disables the requiring a move to a new line. If no suffix is given,
 the debugger setting 'different' determines this behavior.
 
-If no suffix is given, the debugger setting 'different'
-determines this behavior.
+If no suffix is given, the debugger setting *different* determines
+this behavior.
 
-Examples: 
-  #{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
+Examples:
+---------
+
+    #{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
+
+See also:
+---------
+`step`, `continue`, `finish`, `set different`
     HELP
 
-    ALIASES      = %W(n #{NAME}+ #{NAME}- #{NAME}< #{NAME}> #{NAME}<> #{NAME}! 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']
@@ -54,15 +60,15 @@ Examples:
     else
       count_str = args[1]
       opts = {
-        :msg_on_error => 
-        "The '#{NAME}' command argument must eval to an integer. Got: %s" % 
+        :msg_on_error =>
+        "The '#{NAME}' command argument must eval to an integer. Got: %s" %
         count_str,
         :min_value => 1
       }
       count = @proc.get_an_int(count_str, opts)
       return unless count
       # step 1 is core.step_count = 0 or "stop next event"
-      step_count = count - 1  
+      step_count = count - 1
     end
     @proc.next(step_count, opts)
   end

data/processor/command/pp.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'
 require 'pp'
 require_relative '../command'
@@ -7,27 +7,29 @@ class Trepan::Command::PPCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
-    HELP = 
-      "#{NAME} EXPRESSION
+    HELP = <<-HELP
+**#{NAME}** *Ruby-expression*
 
-Prtty Print the value of the EXPRESSION. Variables accessible are
+Prtty 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.
-"
+See also:
+---------
+`set max string` to change the string truncation limit.
+HELP
     CATEGORY      = 'data'
     SHORT_HELP    = 'pretty print expression truncating long output'
   end
-  
+
   def run(args)
     obj = @proc.debug_eval(@proc.cmd_argstr)
     msg (obj.respond_to?(:pretty_inspect) ? obj.pretty_inspect : obj.inspect)
   end
 end
-        
+
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup

data/processor/command/pr.rb

@@ -1,32 +1,34 @@
 # -*- 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'
 class Trepan::Command::PrCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-      "#{NAME} EXPRESSION
+**#{NAME}** *ruby-expression*
 
-Print the value of the EXPRESSION. Variables accessible are those of the
-environment of the selected stack frame, plus globals. 
+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.
+See also:
+---------
+`set max string` to change the string truncation limit.
     HELP
 
     # ALIASES       = %w(p)
     CATEGORY      = 'data'
     SHORT_HELP    = 'print expression truncating long output'
   end
-  
+
   def run(args)
     @proc.eval_code(@proc.cmd_argstr, @proc.settings[:maxstring])
   end
 end
-        
+
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup

data/processor/command/ps.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 require_relative '../eval'
 class Trepan::Command::PsCommand < Trepan::Command
@@ -7,16 +7,16 @@ class Trepan::Command::PsCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} ARRAY
+**#{NAME}* *Ruby-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
     SHORT_HELP    = 'Print array sorted and in columns'
   end
-  
+
   def run(args)
     array = @proc.debug_eval(@proc.cmd_argstr, @proc.settings[:maxstring])
     # FIXME: should test for enumerable
@@ -27,7 +27,7 @@ Print the value of the ARRAY in columns and sorted.
     end
   end
 end
-        
+
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup

data/processor/command/quit.rb

@@ -1,27 +1,31 @@
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2013 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rbconfig'
 require_relative '../command'
 class Trepan::Command::QuitCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME}[!] [unconditionally] [exit code] 
+**#{NAME}**[!] [**unconditionally**] [*exit-code*]
 
-gentle termination
+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
-passed to exit() - presumably the return code that will be passed back
+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
+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: 
-  #{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
+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 the commands "exit" and "kill".
+See also:
+---------
+`exit`, `kill`
     HELP
 
     ALIASES      = %W(#{NAME}! q q!)
@@ -35,7 +39,10 @@ See also the commands "exit" and "kill".
 
   # This method runs the command
   def run(args)
-    unconditional = 
+    if RbConfig::CONFIG['target_os'].start_with?('mingw')
+        return @proc.commands['exit'].run(['exit', args])
+    end
+    unconditional =
       if args.size > 1 && args[-1] == 'unconditionally'
         args.shift
         true
@@ -48,7 +55,7 @@ See also the commands "exit" and "kill".
       msg('Quit not confirmed.')
       return
     end
-    
+
     if (args.size > 1)
       if  args[1] =~ /\d+/
         exitrc = args[1].to_i;
@@ -69,8 +76,8 @@ end
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
-  Process.fork { cmd.run([cmd.name]) } if 
-    Process.respond_to?(:fork) 
+  Process.fork { cmd.run([cmd.name]) } if
+    Process.respond_to?(:fork)
   cmd.run([cmd.name, 'foo'])
   cmd.run([cmd.name, '5'])
 end

data/processor/command/raise.rb

@@ -1,24 +1,24 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 class Trepan::Command::RaiseCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [exception-name]
+**#{NAME}** [*exception-name*]
 
-Raise an EXCEPTION-NAME in the debugged program. If no exception name
-is given, raise RuntimeError.
+Raise an *execption-name* in the debugged program. If no exception name
+is given, raise `RuntimeError`.
     HELP
 
     CATEGORY     = 'running'
     MAX_ARGS     = 1  # Need at most this many
     SHORT_HELP  = 'Raise an exception in the debugged program'
   end
-    
+
   # This method runs the command
   def run(args)
-    exception = 
+    exception =
       if args.size > 1
         except_str = args[1..-1].join(' ')
         # Normally would need x.respond_to? && ..

data/processor/command/reload.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 'base/submgr'
 require_relative '../../app/util'
 
@@ -7,10 +7,17 @@ class Trepan::Command::ReloadCommand < Trepan::SubcommandMgr
   Trepan::Util.suppress_warnings {
     NAME          = File.basename(__FILE__, '.rb')
     ALIASES       = %w(rel)
-    HELP          = 'Reload information'
     CATEGORY      = 'data'
     NEED_STACK    = false
     SHORT_HELP    = 'Reload information'
+    HELP = <<-HELP
+**#{NAME}** [*reload-subcommand*]
+
+Reload debugger information after something has changed.
+For example if you change the Ruby code for a debugger *quit*,
+`reload command quit` will get the change seen inside the
+currently-running debugger.
+   HELP
   }
 
   def initialize(proc)

data/processor/command/reload_subcmd/command.rb

@@ -1,15 +1,15 @@
 # -*- 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::ReloadCommand < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = <<-HELP
-reload command [file-or-directory ...]
+**#{PREFIX.join(' ')}** [*file-or-directory* ...]
 
-Loads or reloads debugger commands. If no parameters are passed all 
-commands are reloaded. If a parameters are passed each is expected to 
+Loads or reloads debugger commands. If no parameters are passed all
+commands are reloaded. If a parameters are passed each is expected to
 be a either a Ruby file which implements a series of debugger
 commands by defining Trepan::Command classes, or a directory which contains
 files that implements debugger commands.

data/processor/command/restart.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/run'
 class Trepan::Command::RestartCommand < Trepan::Command
@@ -8,17 +8,22 @@ class Trepan::Command::RestartCommand < Trepan::Command
     NAME         = File.basename(__FILE__, '.rb')
     ALIASES      = %w(R run)
     HELP = <<-HELP
-#{NAME} 
+**#{NAME}**
 
 Restart debugger and program via an exec call. All state is lost, and
 new copy of the debugger is used.
+
+See also:
+---------
+
+`set args`, `show args`
     HELP
-    
+
     CATEGORY     = 'running'
     MAX_ARGS     = 0  # Need at most this many
     SHORT_HELP  = '(Hard) restart of program via exec()'
   end
-    
+
   # This method runs the command
   def run(args)
 

data/processor/command/save.rb

@@ -1,14 +1,14 @@
 # -*- 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'
 class Trepan::Command::SaveCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [--[no-]erase] [--output|-o FILENAME]
+**#{NAME}** [{**--erase**|**--no-eraese**}] [**--output**|**-o** *filename*]
 
-Save settings to file FILENAME. If FILENAME not given one will be made
+Save settings to file *filename*. If *filename* not given one will be made
 selected.
     HELP
 
@@ -18,16 +18,16 @@ selected.
 
     DEFAULT_OPTIONS = { :erase => true, }
   end
-    
+
   def parse_options(options, args) # :nodoc
     parser = OptionParser.new do |opts|
-      opts.on("-e", "--[no-]erase", 
+      opts.on("-e", "--[no-]erase",
               "Add line to erase after reading") do
-        |v| 
+        |v|
         options[:erase] = v
       end
-      opts.on("-o", "--output FILE", String, 
-              "Save file to FILE. ") do 
+      opts.on("-o", "--output FILE", String,
+              "Save file to FILE. ") do
         |filename|
         options[:filename] = filename
       end
@@ -50,7 +50,7 @@ if __FILE__ == $0
   dbgr, cmd = MockDebugger::setup
   cmd.run([cmd.name])
   # require_relative '../../lib/trepanning'; debugger
-  cmd.run([cmd.name, '--erase', 
+  cmd.run([cmd.name, '--erase',
            '--output', File.join(Dir.tmpdir, 'save_file.txt')])
   # A good test would be to see we can read in those files without error.
 end

data/processor/command/server.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2011, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require 'optparse'
 require_relative '../command'
 require_relative '../../app/default'
@@ -15,37 +15,38 @@ class Trepan::Command::ServerCommand < Trepan::Command
     MAX_ARGS     = 4  # Need at most this many
     NAME         = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [{--port|-p} NUM] [{--host|-h} HOST-OR-IP]
+**#{NAME}** [{**--port**|**-p**} *num*] [{**--host**|**-h**} *host-or-IP*]
 
 Put session into server mode which allows an out-of-process or remote
-connection to the debugged program. --port and --host can be supplied
+connection to the debugged program. `--port` and `--host` can be supplied
 to specify the port number to use and the host name for TCP
-connections. If neither is given, the default host (#{Trepan::DEFAULT_SETTINGS[:host]}) 
+connections. If neither is given, the default host (#{Trepan::DEFAULT_SETTINGS[:host]})
 and the default port (#{Trepan::DEFAULT_SETTINGS[:port]}) are used.
 
 Examples:
-   #{NAME} # Accept remote connections using defaults
-   #{NAME} --port 123 # Accept remote connections on port 123
-   #{NAME} --host my.host.net --port 2048
-   #{NAME} -h my.host.net -p 2048 # same as above
+---------
+    #{NAME} # Accept remote connections using defaults
+    #{NAME} --port 123 # Accept remote connections on port 123
+    #{NAME} --host my.host.net --port 2048
+    #{NAME} -h my.host.net -p 2048 # same as above
       HELP
 
     SHORT_HELP  = 'Go into out-of-process debugging (server) mode'
 
   end
-    
+
   def parse_options(options, args) # nodoc
     parser = OptionParser.new do |opts|
-      opts.on("-h", "--host NAME", String, 
-              "Host or IP used in TCP connections for --server or --client. " + 
-              "Default is #{DEFAULT_SETTINGS[:host].inspect}.") do 
-        |name_or_ip| 
+      opts.on("-h", "--host NAME", String,
+              "Host or IP used in TCP connections for --server or --client. " +
+              "Default is #{DEFAULT_SETTINGS[:host].inspect}.") do
+        |name_or_ip|
         options[:host] = name_or_ip
       end
-      opts.on("-p", "--port NUMBER", Integer, 
-              "Port number used in TCP connections for --server or --client. " + 
-              "Default is #{DEFAULT_SETTINGS[:port]}.") do 
-        |num| 
+      opts.on("-p", "--port NUMBER", Integer,
+              "Port number used in TCP connections for --server or --client. " +
+              "Default is #{DEFAULT_SETTINGS[:port]}.") do
+        |num|
         options[:port] = num
       end
     end