trepanning 0.1.0 → 0.1.1

data/processor/command/show_subcmd/auto_subcmd/.gitignore

@@ -0,0 +1 @@
+/*~

data/processor/command/show_subcmd/basename.rb

@@ -14,13 +14,5 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../mock'
-
-  # FIXME: DRY the below code
-  dbgr, cmd = MockDebugger::setup('show')
-  subcommand = Trepan::Subcommand::ShowBasename.new(cmd)
-  testcmdMgr = Trepan::Subcmd.new(subcommand)
-
-  subcommand.run_show_bool
-  name = File.basename(__FILE__, '.rb')
-  subcommand.summary_help(name)
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::ShowBasename)
 end

data/processor/command/show_subcmd/confirm.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+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"
+    MIN_ABBREV = 'co'.size
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+
+  # FIXME: DRY the below code
+  dbgr, cmd = MockDebugger::setup('show')
+  subcommand = Trepan::Subcommand::ShowConfirm.new(cmd)
+  testcmdMgr = Trepan::Subcmd.new(subcommand)
+
+  subcommand.run_show_bool
+  name = File.confirm(__FILE__, '.rb')
+  subcommand.summary_help(name)
+end

data/processor/command/show_subcmd/debug_subcmd/.gitignore

@@ -0,0 +1 @@
+/*~

data/processor/command/show_subcmd/macro.rb

@@ -1,21 +1,46 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
+require_relative '../../../app/complete'
 
 class Trepan::Subcommand::ShowMacro < Trepan::Subcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP = "Show defined macros"
+    HELP = <<-HELP
+#{CMD} 
+#{CMD} *
+#{CMD} MACRO1 [MACRO2 ..]
+
+In the first form a list of the existing macro names are shown
+in column format.
+
+In the second form, all macro names and their definitions are show.
+
+In the last form the only definitions of the given macro names is shown.
+    HELP
+    SHORT_HELP = "Show defined macros"
     MIN_ABBREV = 'ma'.size
   end
 
+  def complete(prefix)
+    Trepan::Complete.complete_token(@proc.macros.keys + %w(*), prefix)
+  end
+
   def run(args)
     if args.size > 2
-      args[2..-1].each do |macro_name|
+      macro_names = 
+        if args.size == 3 && '*' == args[2] 
+          @proc.macros.keys
+        else
+          args[2..-1]
+        end        
+      macro_names.each do |macro_name|
         if @proc.macros.member?(macro_name)
-          msg "%s: %s" % [macro_name, @proc.macros[macro_name]]
+          section "#{macro_name}:"
+          string = @proc.macros[macro_name][1]
+          msg "  #{@proc.ruby_format(string)}", {:unlimited => true}
         else
-          msg "%s is not a defined macro" % macro_name
+          errmsg "%s is not a defined macro" % macro_name
         end
       end
     elsif @proc.macros.empty?
@@ -29,15 +54,8 @@ end
 
 if __FILE__ == $0
   # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this agin
   require_relative '../../mock'
-
-  # FIXME: DRY the below code
-  dbgr, cmd = MockDebugger::setup('show')
-  subcommand = Trepan::Subcommand::ShowMacro.new(cmd)
-  testcmdMgr = Trepan::Subcmd.new(subcommand)
-
-  name = File.basename(__FILE__, '.rb')
-  subcommand.summary_help(name)
-  subcommand.run(%W(show #{name}))
-  subcommand.run(%W(show #{name} u foo))
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::ShowMacro)
+  cmd.run(cmd.prefix + %w(u foo))
 end

data/processor/command/show_subcmd/max_subcmd/.gitignore

@@ -0,0 +1 @@
+/*~

data/processor/command/show_subcmd/trace_subcmd/.gitignore

@@ -0,0 +1 @@
+/*~

data/processor/command/show_subcmd/trace_subcmd/buffer.rb

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../../base/subsubcmd'
 
 class Trepan::SubSubcommand::ShowTraceBuffer < Trepan::ShowBoolSubSubcommand
+  Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
   unless defined?(HELP)
-    HELP         = 
-"show trace buffer [NUM]
+    HELP         = <<-EOH
+#{CMD} [NUM]
 
 Show the events recorded in the event buffer. If NUM is a negative
 number, events run starting from that many debugger stops back. If NUM
@@ -13,15 +14,13 @@ is a positive number, we print starting from that (adjusted) position
 in the event buffer with Since the event buffer may be a ring, its
 zero being the first position. (Since the event buffer may be a ring
 the earliest position recorded may move around.)
-"
+    EOH
     MIN_ABBREV   = 'b'.size
-    NAME         = File.basename(__FILE__, '.rb')
-    PREFIX       = %w(show trace buffer)
     SHORT_HELP   = "Show tracing buffer"
   end
 
   def parse_show_buffer_args(args)
-    marksize = @proc.eventbuf.marks.size
+    marksize = @proc.eventbuf.size
     opts = {
       :max_value    => @proc.eventbuf.size,
       :min_value    => - marksize,
@@ -30,12 +29,8 @@ the earliest position recorded may move around.)
     }
     num = @proc.get_an_int(args[0], opts)
     return nil, nil unless num
-    first = 
-      if num < 0 
-        @proc.eventbuf.marks[marksize+num] 
-      else
-        @proc.eventbuf.zero_pos + num
-      end
+    num = marksize + num  if num < 0 
+    first = @proc.eventbuf.zero_pos + num
     return first, nil
   end
 
@@ -63,22 +58,7 @@ if __FILE__ == $0
   # Demo it.
   require_relative '../../../mock'
   require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, show_cmd = MockDebugger::setup('show')
-  testcmdMgr     = Trepan::Subcmd.new(show_cmd)
-  trace_cmd      = Trepan::SubSubcommand::ShowTrace.new(dbgr.core.processor, 
-                                                        show_cmd)
-
-  # FIXME: remove the 'join' below
-  cmd_name       = Trepan::SubSubcommand::ShowTraceBuffer::PREFIX.join('')
-  tb_cmd         = Trepan::SubSubcommand::ShowTraceBuffer.new(show_cmd.proc, 
-                                                              trace_cmd,
-                                                              cmd_name)
-  # require_relative '../../../../lib/trepanning'
-  # dbgr = Trepan.new
-  # dbgr.debugger
-  tb_cmd.run([])
-
+  require_relative '../trace'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::ShowTrace,
+                                   Trepan::SubSubcommand::ShowTraceBuffer)
 end

data/processor/command/show_subcmd/trace_subcmd/print.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../../base/subsubcmd'
 
 class Trepan::SubSubcommand::ShowTracePrint < Trepan::ShowBoolSubSubcommand
@@ -16,23 +16,7 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../../mock'
-  require_relative '../../../subcmd'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, show_cmd = MockDebugger::setup('show')
-  testcmdMgr     = Trepan::Subcmd.new(show_cmd)
-  trace_cmd      = Trepan::SubSubcommand::ShowTrace.new(dbgr.core.processor, 
-                                                        show_cmd)
-
-  # FIXME: remove the 'join' below
-  cmd_name       = Trepan::SubSubcommand::ShowTracePrint::PREFIX.join('')
-  tb_cmd         = Trepan::SubSubcommand::ShowTracePrint.new(show_cmd.proc, 
-                                                             trace_cmd,
-                                                             cmd_name)
-  # require_relative '../../../../lib/trepanning'
-  # dbgr = Trepan.new
-  # dbgr.debugger
-  tb_cmd.run([])
-
+  require_relative '../trace'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::ShowTrace,
+                                   Trepan::SubSubcommand::ShowTracePrint)
 end

data/processor/command/source.rb

@@ -9,7 +9,6 @@ require_relative '../../io/null_output'
 require_relative '../../app/default'
 
 class Trepan::Command::SourceCommand < Trepan::Command
-  include Trepanning
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
@@ -49,6 +48,13 @@ unless option -c or --continue is given.
 
   end
 
+  def complete(prefix)
+    # opts = %w(-c --continue --no-continue -N --no -y --yes
+    #           --verbose --no-verbose)
+    # return Trepan::Complete.complete_token(opts, prefix) if prefix.empty?
+    Readline::FILENAME_COMPLETION_PROC.call(prefix) || []
+  end
+    
   def parse_options(options, args) # :nodoc
     seen_yes_no = false
     parser = OptionParser.new do |opts|

data/processor/command/up.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
 
 # up command. Like 'down' butthe direction (set by DIRECTION) is different.
@@ -29,6 +29,10 @@ See also 'down' and 'frame'.
   require_relative '../../app/frame'
   include Trepan::Frame
 
+  def complete(prefix)
+    @proc.frame_complete(prefix, @direction)
+  end
+  
   def initialize(proc)
     super
     @direction = +1 # -1 for down.
@@ -47,14 +51,13 @@ See also 'down' and 'frame'.
       # Form is: "down" which means "down 1"
       count = 1
     else
-      stack_size = @proc.top_frame.stack_size - @proc.hide_level
+      low, high = @proc.frame_low_high(@direction)
       count_str = args[1]
       name_or_id = args[1]
       opts = {
         :msg_on_error => 
         "The '#{NAME}' command argument requires a frame number. Got: %s" % count_str,
-        :min_value => -stack_size,
-        :max_value => stack_size-1
+        :min_value => low, :max_value => high
       }
       count = @proc.get_an_int(count_str, opts)
       return false unless count

data/processor/default.rb

@@ -9,6 +9,7 @@ class Trepan
       :autolist      => false,     # Run 'list' 
 
       :basename      => false,     # Show basename of filenames only
+      :confirm       => true,      # Confirm potentially dangerous operations?
       :different     => 'nostack', # stop *only* when  different position? 
 
       :debugdbgr     => false,     # Debugging the debugger
@@ -24,6 +25,7 @@ class Trepan
                                    # means hide none. Less than 0 means show
                                    # all stack entries.
       :hightlight    => false,     # Use terminal highlight? 
+      
       :maxlist       => 10,        # Number of source lines to list 
       :maxstack      => 10,        # backtrace limit
       :maxstring     => 150,       # Strings which are larger than this
@@ -39,7 +41,7 @@ class Trepan
       :tracebuffer   => false,     # save events to a trace buffer.
       :user_cmd_dir  => File.join(Trepan::HOME_DIR, 'tepanx', 'command'),
                                    # User command directory
-    } 
+    }
   end
 end
 

data/processor/eval.rb

@@ -24,6 +24,19 @@ class Trepan
       end
     end
 
+    def eval_code(str, max_fake_filename)
+      obj = debug_eval(str, max_fake_filename)
+      
+      # idx = @user_variables
+      # @user_variables += 1
+      
+      # str = "$d#{idx}"
+      # Rubinius::Globals[str.to_sym] = obj
+      # msg "#{str} = #{obj.inspect}"
+      msg "#{obj.inspect}"
+      obj
+    end
+
     def exception_dump(e, stack_trace, backtrace)
       str = "#{e.class} Exception:\n\t#{e.message}"
       if stack_trace

data/processor/eventbuf.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 # For recording hook events in a buffer for review later. Make use of
 # Trace::Buffer for this prupose.
 require 'trace'
@@ -94,7 +94,8 @@ class Trepan
         mess += "\n\tVM offset #{item.pc_offset}"
       end
       unless same_loc
-        text = LineCache::getline(container, location, @reload_on_change)
+        text = LineCache::getline(container, location, 
+                                  :reload_on_change => @reload_on_change)
         mess += ":\n  #{text.chomp}" if text
       end
       return container, location, mess

data/processor/frame.rb

@@ -1,5 +1,6 @@
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
 require 'linecache'
+require_relative '../app/complete'
 require_relative '../app/frame'
 class Trepan
   class CmdProcessor
@@ -51,6 +52,24 @@ class Trepan
       end
     end
 
+    def frame_low_high(direction)
+      stack_size = @top_frame.stack_size - @hide_level
+      if direction
+        low, high = [ @frame_index * -direction, 
+                      (stack_size - 1 - @frame_index) * direction ]
+        low, high = [high, low] if direction < 0
+        [low, high]
+      else
+        [-stack_size, stack_size-1]
+      end
+    end
+    
+    def frame_complete(prefix, direction)
+      low, high = frame_low_high(direction)
+      ary = (low..high).map{|i| i.to_s}
+      Trepan::Complete.complete_token(ary, prefix)
+    end
+
     def frame_container(frame, canonicalize=true)
       container = 
         if @remap_container.member?(frame.source_container)

data/processor/help.rb

@@ -1,5 +1,25 @@
 # Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
 class Trepan
+  # class SubHelp
+  #   def initialize(name, dir)
+  #     @name = name
+  #     @dir  = dir
+  #     load_sub_help_files(dir)
+  #   end
+
+  #   def load_sub_help_files(dir)
+  #     Dir.glob(dir, '*.txt').each do |txt| 
+  #       basename = File.basename(txt, '.txt')
+  #       @list << basename
+  #     end
+  #   end if File.directory?(dir)
+
+  #   def summary_help
+  #     section "List of #{@name} help"
+  #     msg @list
+  #   end
+  # end
+
   module Help
 
     def abbrev_stringify(name, min_abbrev)

data/processor/load_cmds.rb

@@ -1,7 +1,11 @@
-# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
-# Trepan::CmdProcess that loads up debugger commands from builtin and
-# user directories.
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net> 
+require 'tmpdir'
+
+# Part of Trepan::CmdProcess that loads up debugger commands from
+# builtin and user directories.  
 # Sets @commands, @aliases, @macros
+require_relative '../app/complete'
 class Trepan
   class CmdProcessor
 
@@ -21,8 +25,8 @@ class Trepan
       cmd_dirs = [ File.join(File.dirname(__FILE__), 'command') ]
       cmd_dirs <<  @settings[:user_cmd_dir] if @settings[:user_cmd_dir]
       cmd_dirs.each do |cmd_dir| 
-          load_debugger_commands(cmd_dir) if File.directory?(cmd_dir)
-        end
+        load_debugger_commands(cmd_dir) if File.directory?(cmd_dir)
+      end
     end
 
     # Loads in debugger commands by require'ing each ruby file in the
@@ -31,7 +35,8 @@ class Trepan
     # is returned.
     def load_debugger_commands(file_or_dir)
       if File.directory?(file_or_dir)
-        Dir.glob(File.join(file_or_dir, '*.rb')).each do |rb| 
+        dir = File.expand_path(file_or_dir)
+        Dir.glob(File.join(dir, '*.rb')).each do |rb| 
           # We use require so that multiple calls have no effect.
           require rb
         end
@@ -56,23 +61,6 @@ class Trepan
       end
     end
 
-    # Instantiate a Trepan::Command and extract info: the NAME, ALIASES
-    # and store the command in @commands.
-    def setup_command(command)
-      # Note: there is probably a non-eval way to instantiate the
-      # command, but I don't know it. And eval works.
-      klass = self.instance_eval("Trepan::Command::#{command}")
-      cmd = klass.send(:new, self)
-      
-      # Add to list of commands and aliases.
-      cmd_name = klass.const_get(:NAME)
-      if klass.constants.member?(:ALIASES)
-        aliases= klass.const_get(:ALIASES)  
-        aliases.each {|a| @aliases[a] = cmd_name}
-      end
-      @commands[cmd_name] = cmd
-    end
-
     # Looks up cmd_array[0] in @commands and runs that. We do lots of 
     # validity testing on cmd_array.
     def run_cmd(cmd_array)
@@ -95,10 +83,138 @@ class Trepan
         @commands[cmd_name].run(cmd_array)
       end
     end
+
+    def save_commands(opts)
+      save_filename = opts[:filename] || 
+        File.join(Dir.tmpdir, Dir::Tmpname.make_tmpname(['trepanning-save', '.txt'], nil))
+      begin
+        save_file = File.open(save_filename, 'w')
+      rescue => exc
+        errmsg("Can't open #{save_filename} for writing.")
+        errmsg("System reports: #{exc.inspect}")
+        return nil
+      end
+      save_file.puts "#\n# Commands to restore trepanning environment\n#\n"
+      @commands.each do |cmd_name, cmd_obj|
+        cmd_obj.save_command if cmd_obj.respond_to?(:save_command)
+        next unless cmd_obj.is_a?(Trepan::SubcommandMgr)
+        cmd_obj.subcmds.subcmds.each do |subcmd_name, subcmd_obj|
+          save_file.puts subcmd_obj.save_command if 
+            subcmd_obj.respond_to?(:save_command)
+          next unless subcmd_obj.is_a?(Trepan::SubSubcommandMgr)
+          subcmd_obj.subcmds.subcmds.each do |subsubcmd_name, subsubcmd_obj|
+            save_file.puts subsubcmd_obj.save_command if 
+              subsubcmd_obj.respond_to?(:save_command)
+          end
+        end
+      end
+      save_file.puts "!FileUtils.rm #{save_filename.inspect}" if 
+        opts[:erase]
+      save_file.close
+
+      return save_filename
+    end
+
+    # Instantiate a Trepan::Command and extract info: the NAME, ALIASES
+    # and store the command in @commands.
+    def setup_command(command)
+      # Note: there is probably a non-eval way to instantiate the
+      # command, but I don't know it. And eval works.
+      klass = self.instance_eval("Trepan::Command::#{command}")
+      cmd = klass.send(:new, self)
+      
+      # Add to list of commands and aliases.
+      cmd_name = klass.const_get(:NAME)
+      if klass.constants.member?(:ALIASES)
+        aliases= klass.const_get(:ALIASES)  
+        aliases.each {|a| @aliases[a] = cmd_name}
+      end
+      @commands[cmd_name] = cmd
+    end
+
+    # Handle initial completion. We draw from the commands, aliases,
+    # and macros for completion. However we won't include aliases which
+    # are prefixes of other commands.
+    def complete(str, last_token)
+      next_blank_pos, token = Trepan::Complete.next_token(str, 0)
+      return [''] if token.empty? && !last_token.empty?
+      match_pairs = Trepan::Complete.complete_token_with_next(@commands,
+                                                               token)
+      match_hash = {}
+      match_pairs.each do |pair|
+        match_hash[pair[0]] = pair[1]
+      end
+      alias_pairs = Trepan::Complete.
+        complete_token_filtered_with_next(@aliases, token, match_hash,
+                                          @commands)
+      match_pairs += alias_pairs
+      if str[next_blank_pos..-1].empty?
+        return match_pairs.map{|pair| pair[0]}.sort
+      else
+        alias_pairs.each do |pair|
+          match_hash[pair[0]] = pair[1]
+        end
+      end
+      if match_pairs.size > 1
+        # FIXME: figure out what to do here.
+        # Matched multiple items in the middle of the string
+        # We can't handle this so do nothing.
+        return []
+        # return match_pairs.map do |name, cmd|
+        #   ["#{name} #{args[1..-1].join(' ')}"]
+        # end
+      end
+      # match_pairs.size == 1
+      next_complete(str, next_blank_pos, match_pairs[0][1], last_token)
+    end
+
+    def next_complete(str, next_blank_pos, cmd, last_token)
+      # debugger if 8 == next_blank_pos
+      next_blank_pos, token = Trepan::Complete.next_token(str, next_blank_pos)
+      return [] if token.empty? && !last_token.empty?
+      
+      if cmd.respond_to?(:complete_token_with_next) 
+        match_pairs = cmd.complete_token_with_next(token)
+        return [] if match_pairs.empty?
+        if str[next_blank_pos..-1].rstrip.empty? && 
+            (token.empty? || token == last_token)
+          return match_pairs.map { |completion, junk| completion }
+        else
+          if match_pairs.size == 1
+            return next_complete(str, next_blank_pos, match_pairs[0][1], 
+                                 last_token)
+          else
+            # FIXME: figure out what to do here.
+            # Matched multiple items in the middle of the string
+            # We can't handle this so do nothing.
+            return []
+          end
+        end
+      elsif cmd.respond_to?(:complete)
+        matches = cmd.complete(token)
+        return [] if matches.empty?
+        if str[next_blank_pos..-1].rstrip.empty? && 
+            (token.empty? || token == last_token)
+          return matches
+        else
+          # FIXME: figure out what to do here.
+          # Matched multiple items in the middle of the string
+          # We can't handle this so do nothing.
+          return []
+        end
+      else
+        return []
+      end
+    end
   end
 end
 if __FILE__ == $0
-  cmdproc = Trepan::CmdProcessor.new
+  class Trepan::CmdProcessor
+    def initialize(core, settings={})
+    end
+  end
+
+  cmdproc = Trepan::CmdProcessor.new(nil)
   cmddir = File.join(File.dirname(__FILE__), 'command')
   cmdproc.instance_variable_set('@settings', {})
   cmdproc.load_cmds_initialize
@@ -119,4 +235,7 @@ if __FILE__ == $0
   cmdproc.run_cmd('foo')  # Invalid - not an Array
   cmdproc.run_cmd([])     # Invalid - empty Array
   cmdproc.run_cmd(['list', 5])  # Invalid - nonstring arg
+  p cmdproc.complete("d")
+  p cmdproc.complete("sho d")
+  p cmdproc.complete('')
 end