trepanning 0.1.6 → 1.93.32

data/processor.rb

@@ -1,18 +1,18 @@
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
-# The main "driver" class for a command processor. Other parts of the 
+# Copyright (C) 2010-2011, 2013, 2015 Rocky Bernstein <rockyb@rubyforge.net>
+# The main "driver" class for a command processor. Other parts of the
 # command class and debugger command objects are pulled in from here.
 
-%w(default breakpoint display eventbuf eval load_cmds location frame hook msg 
-   running validate).each do
+%w(default breakpoint complete display eventbuf eval load_cmds location
+    frame hook msg running validate).each do
   |mod_str|
   require_relative "processor/#{mod_str}"
 end
 require_relative 'app/brkptmgr'
 
 class Trepan
-  class CmdProcessor < VirtualCmdProcessor
+    class CmdProcessor < VirtualCmdProcessor
 
-    # SEE ALSO attr's in require_relative's of loop above.
+        # SEE ALSO attr's in require_relative's of loop above.
 
     attr_reader   :cmd_argstr      # Current command args, a String.
                                    # This is current_command with the command
@@ -25,7 +25,7 @@ class Trepan
                                    # Trepan::Core instance)
     attr_accessor :debug_nest      # Number of nested debugs. Used in showing
                                    # prompt.
-    attr_accessor :different_pos   # Same type as settings[:different] 
+    attr_accessor :different_pos   # Same type as settings[:different]
                                    # this is the temporary value for the
                                    # next stop while settings is the default
                                    # value to use.
@@ -34,8 +34,8 @@ class Trepan
                                    # Trepan::Core instance)
     attr_reader   :interfaces      # Array of all interfaces
     attr_accessor :leave_cmd_loop  # Commands set this to signal to leave
-                                   # the command loop (which often continues to 
-                                   # run the debugged program). 
+                                   # the command loop (which often continues to
+                                   # run the debugged program).
     attr_accessor :line_no         # Last line shown in "list" command
     attr_accessor :next_level      # Fixnum. frame.stack_size has to
                                    # be <= than this.  If next'ing,
@@ -43,17 +43,17 @@ class Trepan
     attr_accessor :next_thread     # Thread. If non-nil then in
                                    # stepping the thread has to be
                                    # this thread.
-    attr_accessor :pass_exception  # Pass an exception back 
+    attr_accessor :pass_exception  # Pass an exception back
     attr_accessor :prompt          # String print before requesting input
     attr_reader   :settings        # Hash[:symbol] of command
                                    # processor settings
-    
+
     attr_accessor :traced_vars     # list of traced global variables
 
     # The following are used in to force stopping at a different line
     # number. FIXME: could generalize to a position object.
     attr_accessor :last_pos       # Last position. 6-Tuple: of
-                                  # [location, container, stack_size, 
+                                  # [location, container, stack_size,
                                   #  current_thread, pc_offset]
 
 
@@ -78,18 +78,18 @@ class Trepan
 
       # FIXME: Rework using a general "set substitute file" command and
       # a global default profile which gets read.
-      file = File.expand_path(File.join(File.dirname(__FILE__), 
+      file = File.expand_path(File.join(File.dirname(__FILE__),
                                         %w(data prelude.rb)))
       LineCache::cache(file)
       LineCache::remap_file('<internal:prelude>', file)
-      file = File.expand_path(File.join(File.dirname(__FILE__), 
+      file = File.expand_path(File.join(File.dirname(__FILE__),
                                         %w(data custom_require.rb)))
       LineCache::cache(file)
-      LineCache::remap_file('<internal:lib/rubygems/custom_require>', 
+      LineCache::remap_file('<internal:lib/rubygems/custom_require>',
                             file)
 
       # Start with empty thread and frame info.
-      frame_teardown 
+      frame_teardown
 
       # Run initialization routines for each of the "submodule"s.
       # load_cmds has to come first.
@@ -98,14 +98,12 @@ class Trepan
         self.send("#{submod}_initialize")
       end
       hook_initialize(commands)
-      unconditional_prehooks.insert_if_new(-1, *trace_hook) if 
+      unconditional_prehooks.insert_if_new(-1, *trace_hook) if
         @settings[:traceprint]
-
-      # FIXME: run start file and start commands.
     end
 
     def compute_prompt
-      thread_str = 
+      thread_str =
         if 1 == Thread.list.size
           ''
         elsif Thread.current == Thread.main
@@ -113,13 +111,15 @@ class Trepan
         else
           "@#{Thread.current.object_id}"
         end
-      "%s#{settings[:prompt]}%s%s: " % 
+      "%s#{settings[:prompt]}%s%s: " %
         ['(' * @debug_nest, thread_str, ')' * @debug_nest]
-      
+
     end
 
     def finalize
       breakpoint_finalize
+      msg "%sThat's all, folks..." %
+        (defined?(Trepan::PROGRAM) ? "#{Trepan::PROGRAM}: " : '')
     end
 
     # Check that we meed the criteria that cmd specifies it needs
@@ -128,13 +128,13 @@ class Trepan
       # Check we have frame is not null
       min_args = cmd.class.const_get(:MIN_ARGS)
       if nargs < min_args
-        errmsg(("Command '%s' needs at least %d argument(s); " + 
+        errmsg(("Command '%s' needs at least %d argument(s); " +
                 "got %d.") % [name, min_args, nargs])
         return false
       end
       max_args = cmd.class.const_get(:MAX_ARGS)
       if max_args and nargs > max_args
-        errmsg(("Command '%s' needs at most %d argument(s); " + 
+        errmsg(("Command '%s' needs at most %d argument(s); " +
                 "got %d.") % [name, max_args, nargs])
         return false
       end
@@ -158,14 +158,14 @@ class Trepan
       return true if @intf.input_eof? && intf_size == 1
       while intf_size > 1 || !@intf.input_eof?
         begin
-          @current_command = 
+          @current_command =
             if @cmd_queue.empty?
               # Leave trailing blanks on for the "complete" command
-              read_command.chomp 
+              read_command.chomp
             else
               @cmd_queue.shift
             end
-          if @current_command.empty? 
+          if @current_command.empty?
             next unless @last_command && intf.interactive?;
           end
           next if @current_command[0..0] == '#' # Skip comment lines
@@ -197,8 +197,8 @@ class Trepan
       frame_setup(frame)
 
       @unconditional_prehooks.run
-      
-      if 'trace-var' == @event 
+
+      if 'trace-var' == @event
         variable_name, value = @core.hook_arg
         action = @traced_vars[variable_name]
         msg "trace: #{variable_name} = #{value}"
@@ -217,7 +217,7 @@ class Trepan
 
       if breakpoint?
         @last_pos = [@frame.source_container, frame_line,
-                     @stack_size, @current_thread, @event, 
+                     @stack_size, @current_thread, @event,
                      @frame.pc_offset]
       elsif @event != 'post-mortem'
         return if stepping_skip? || @stack_size <= @hide_level
@@ -232,7 +232,7 @@ class Trepan
 
       print_location unless @settings[:traceprint]
       @eventbuf.add_mark if @settings[:tracebuffer]
- 
+
       @cmdloop_prehooks.run
       while not @leave_cmd_loop do
         begin
@@ -256,7 +256,7 @@ class Trepan
     # Run current_command, a String. @last_command is set after the
     # command is run if it is a command.
     def run_command(current_command)
-      eval_command = 
+      eval_command =
         if current_command[0..0] == '!'
           current_command[0] = ''
         else
@@ -277,7 +277,7 @@ class Trepan
           break unless @macros.member?(macro_cmd_name)
           current_command = @macros[macro_cmd_name][0].call(*args[1..-1])
           msg current_command.inspect if settings[:debugmacro]
-          if current_command.is_a?(Array) && 
+          if current_command.is_a?(Array) &&
               current_command.all? {|val| val.is_a?(String)}
             args = (first=current_command.shift).split
             @cmd_queue += current_command
@@ -292,21 +292,21 @@ class Trepan
         end
 
         @cmd_name = args[0]
-        run_cmd_name = 
+        run_cmd_name =
           if @aliases.member?(@cmd_name)
-            @aliases[@cmd_name] 
+            @aliases[@cmd_name]
           else
             @cmd_name
           end
-        
+
         run_cmd_name = uniq_abbrev(@commands.keys, run_cmd_name) if
           !@commands.member?(run_cmd_name) && @settings[:abbrev]
-          
+
         if @commands.member?(run_cmd_name)
           cmd = @commands[run_cmd_name]
           if ok_for_running(cmd, run_cmd_name, args.size-1)
             @cmd_argstr = current_command[@cmd_name.size..-1].lstrip
-            cmd.run(args) 
+            cmd.run(args)
             @last_command = current_command
           end
           return false
@@ -329,7 +329,7 @@ class Trepan
 
     # Error message when a command doesn't exist
     def undefined_command(cmd_name)
-      begin 
+      begin
         errmsg('Undefined command: "%s". Try "help".' % cmd_name)
       rescue
         $stderr.puts 'Undefined command: "%s". Try "help".' % cmd_name
@@ -381,7 +381,7 @@ if __FILE__ == $0
     end
     $input = ['1+2']
     dbg.core.processor.process_command_and_quit?
-    $input = ['!s = 5']  # ! means eval line 
+    $input = ['!s = 5']  # ! means eval line
     dbg.core.processor.process_command_and_quit?
   end
 end

data/processor/command.rb

@@ -2,7 +2,7 @@
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # Base class of all commands. Code common to all commands is here.
 # Note: don't end classname with Command (capital C) since main
-# will think this a command name like QuitCommand 
+# will think this a command name like QuitCommand
 require 'columnize'
 require_relative '../app/complete'
 
@@ -30,7 +30,7 @@ class Trepan
     # List commands arranged in an aligned columns
     def columnize_commands(commands)
       width = settings[:maxwidth]
-      Columnize::columnize(commands, width, ' ' * 4, 
+      Columnize::columnize(commands, width, ' ' * 4,
                            true, true, ' ' * 2).chomp
     end
 
@@ -52,7 +52,7 @@ class Trepan
     end
 
     def obj_const(obj, name)
-      obj.class.const_get(name) 
+      obj.class.const_get(name)
     end
 
     # Convenience short-hand for @proc.msg
@@ -92,23 +92,27 @@ class Trepan
       @proc.section(message, opts)
     end
 
+    def markdown(message, opts={})
+      @proc.markdown(message, opts)
+    end
+
     def settings
       @proc.settings
     end
 
     def short_help
-      help_constant_sym = if self.class.constants.member?(:SHORT_HELP) 
-                            :SHORT_HELP 
+      help_constant_sym = if self.class.constants.member?(:SHORT_HELP)
+                            :SHORT_HELP
                           else :HELP
                           end
       my_const(help_constant_sym)
     end
 
     # Define a method called 'complete' on the singleton class.
-    def self.completion(ary) 
-      self.send(:define_method, 
-                :complete, 
-                Proc.new {|prefix| 
+    def self.completion(ary)
+      self.send(:define_method,
+                :complete,
+                Proc.new {|prefix|
                   Trepan::Complete.complete_token(ary, prefix) })
     end
   end

data/processor/command/alias.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010-2011, 2013, 2015 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../command'
 
 class Trepan::Command::AliasCommand < Trepan::Command
@@ -6,31 +6,37 @@ class Trepan::Command::AliasCommand < Trepan::Command
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} ALIAS COMMAND
+**#{NAME}** *alias* *command*
 
-Add alias ALIAS for a debugger command COMMAND.  
+Add alias *alias* for a debugger command *command*.
 
 Add an alias when you want to use a command abbreviation for a command
-that would otherwise be ambigous. For example, by default we make 's'
-be an alias of 'step' to force it to be used. Without the alias, "s"
-might be "step", "show", or "set" among others
+that would otherwise be ambigous. For example, by default we make `s`
+be an alias of `step` to allow it to unambigously refer to that command.
 
-Example:
+Without the alias, `s` might be mean `step`, `show`, or `set` among
+others
 
-alias cat list   # "cat rubyfile.rb" is the same as "list rubyfile.rb"
-alias s   step   # "s" is now an alias for "step".
-                 # The above examples done by default.
+Examples:
+--------
 
-See also 'unalias' and 'show #{NAME}'.
+    alias cat list   # "cat rubyfile.rb" is the same as "list rubyfile.rb"
+    alias s   step   # "s" is now an alias for "step".
+                     # The above example is done by default.
+
+See also:
+---------
+
+`unalias` and `show #{NAME}`.
     HELP
 
     CATEGORY      = 'support'
     MAX_ARGS      = 2  # Need at most this many
-    NEED_STACK    = true
+    NEED_STACK    = false
     SHORT_HELP    = 'Add an alias for a debugger command'
   end
-  
-  # Run command. 
+
+  # Run command.
   def run(args)
     if args.size == 1
       @proc.commands['show'].run(%W(show #{NAME}))
@@ -42,7 +48,7 @@ See also 'unalias' and 'show #{NAME}'.
       if @proc.commands.member?(command)
         @proc.aliases[al] = command
         if old_command
-          msg("Alias '#{al}' for command '#{command}' replaced old " + 
+          msg("Alias '#{al}' for command '#{command}' replaced old " +
               "alias for '#{old_command}'.")
         else
           msg "New alias '#{al}' for command '#{command}' created."

data/processor/command/backtrace.rb

@@ -1,26 +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::BacktraceCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME          = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [count]
+**#{NAME}** [*count*]
 
 Print a stack trace, with the most recent frame at the top.  With a
 positive number, print at most many entries.  With a negative number
 print the top entries minus that number.
 
-An arrow indicates the 'current frame'. The current frame determines
-the context used for many debugger commands such as expression
-evaluation or source-line listing.
+In the listing produced, an arrow `-->` indicates the 'current
+frame'. The current frame determines the context used for many
+debugger commands such as in expression evaluation, `eval`, or in
+source-line listing, `list`, or the `edit` command.
 
 Examples:
-   #{NAME}    # Print a full stack trace
-   #{NAME} 2  # Print only the top two entries
-   #{NAME} -1 # Print a stack trace except the initial (least recent) call."
-      HELP
+---------
+
+    #{NAME}    # Print a full stack trace
+    #{NAME} 2  # Print only the top two entries
+    #{NAME} -1 # Print a stack trace except the initial (least recent) call."
+
+See also:
+---------
+
+`up`, `down`, `frame`.
+HELP
 
     ALIASES       = %w(bt where)
     CATEGORY      = 'stack'
@@ -35,17 +43,17 @@ Examples:
   def complete(prefix)
     @proc.frame_complete(prefix, nil)
   end
-  
+
   # This method runs the command
   def run(args)
     unless @proc.frame
       errmsg 'No frame.'
       return false
     end
-    hide_level  = 
-      if (!settings[:hidelevel] || settings[:hidelevel] < 0) && 
-          @proc.hidelevels[Thread.current] 
-        @proc.hidelevels[Thread.current] 
+    hide_level  =
+      if (!settings[:hidelevel] || settings[:hidelevel] < 0) &&
+          @proc.hidelevels[Thread.current]
+        @proc.hidelevels[Thread.current]
       else settings[:hidelevel]
       end
     stack_size = @proc.top_frame.stack_size - hide_level
@@ -56,19 +64,19 @@ Examples:
       :maxwidth    => settings[:maxwidth],
       :show_pc     => settings[:show_pc]
     }
-    opts[:count] = 
+    opts[:count] =
       if args.size > 1
-        opts[:maxstack] = @proc.get_int(args[1], 
+        opts[:maxstack] = @proc.get_int(args[1],
                                        :cmdname   => self.name,
                                        :max_value => stack_size)
       else
         stack_size
       end
     return false unless opts[:count]
-    # FIXME: Fix Ruby so we don't need this workaround? 
+    # FIXME: Fix Ruby so we don't need this workaround?
     # See also location.rb
-    opts[:class] = @proc.core.hook_arg  if 
-      'CFUNC' == @proc.frame.type && 
+    opts[:class] = @proc.core.hook_arg  if
+      'CFUNC' == @proc.frame.type &&
       @proc.core.hook_arg && @proc.event != 'raise'
     print_stack_trace(@proc.top_frame, opts)
   end