trepanning 0.1.2 → 0.1.3

data/processor/command/macro.rb

@@ -40,7 +40,7 @@ With the above, 'dbgcmd list 5' will ultimately expand to:
 
 and will debug the debugger's 'list' command on the command 'list 5'.
 
-See also 'show macro'.
+See also 'info macro'.
     HELP
 
     CATEGORY      = 'support'

data/processor/command/parsetree.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+begin
+  require 'rubygems'
+  require 'parse_tree'
+  require_relative 'base/cmd'
+  require_relative '../../app/cmd_parse'
+  class Trepan::Command::ParseTreeCommand < Trepan::Command
+    
+    unless defined?(HELP)
+      NAME = File.basename(__FILE__, '.rb')
+      HELP = <<-HELP
+#{NAME}
+#{NAME}  method
+
+In the first form, print a ParseTree S-expression of the current 
+class. 
+In the second form, preint a ParseTree S-expression of the current method.
+In the third form print a ParseTree S-expression of CLASS.
+In the fourth form, print a ParseTree S-expression of the given method.
+HELP
+
+    # ALIASES       = %w(p)
+      CATEGORY      = 'data'
+      SHORT_HELP    = 'PrettyPrint a ParseTree S-expression'
+    end
+    
+    def run(args)
+      @processor ||= ParseTree19.new(false)
+      meth = nil
+      case args.size
+      when 1
+        method_name = @proc.frame.method
+      when 2
+        method_name = args[1]
+      else
+        errmsg 'Expecting a method name'
+        return
+      end
+      meth = Trepan::CmdParser.meth_for_string(method_name, @proc.frame.binding)
+      if meth and meth.kind_of?(Method)
+        msg @processor.parse_tree_for_method(meth, true).pretty_inspect
+      end
+    end
+
+    if __FILE__ == $0
+      require 'pp'
+      require_relative '../mock'
+      dbgr, cmd = MockDebugger::setup
+      cmd.proc.frame.instance_variable_set('@binding', TOPLEVEL_BINDING)
+      cmd.run([cmd.name, 'FileUtils.rm'])
+    end
+    
+  end
+rescue LoadError
+end

data/processor/command/pp.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'
+require 'pp'
+require_relative 'base/cmd'
+class Trepan::Command::PPCommand < Trepan::Command
+
+  unless defined?(HELP)
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = 
+      "#{NAME} EXPRESSION
+
+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.
+
+See 'set max string' to change the string truncation limit.
+"
+    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
+  ['(0..10).to_a', '$LOADED_FEATURES'].each do |expr_str|
+    cmd_argstr = expr_str
+      cmd.proc.instance_variable_set('@cmd_argstr', cmd_argstr)
+    cmd.run([cmd.name, cmd_argstr])
+    puts '-' * 20
+  end
+end

data/processor/command/pr.rb

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative 'base/cmd'
-require_relative '../eval'
 class Trepan::Command::PrCommand < Trepan::Command
 
   unless defined?(HELP)

data/processor/command/quit.rb

@@ -51,6 +51,8 @@ See also the commands "exit" and "kill".
 
     exitrc = (args.size > 1) ? exitrc = Integer(args[1]) rescue 0 : 0
     # No graceful way to stop threads...
+    @proc.finalize
+    @proc.dbgr.intf[-1].finalize
     exit exitrc
   end
 end
@@ -58,7 +60,6 @@ end
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
-  name = File.basename(__FILE__, '.rb')
   fork { cmd.run([cmd.name]) }
   cmd.run([cmd.name, '5'])
 end

data/processor/command/set_subcmd/abbrev.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::SetAbbrev < Trepan::SetBoolSubcommand
+  unless defined?(HELP)
+    HELP = "Set to allow unique abbreviations of commands"
+    IN_LIST    = true
+    MIN_ABBREV = 'ab'.size
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this again
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::SetAbbrev, false)
+  cmd.run(cmd.prefix + ['off'])
+  cmd.run(cmd.prefix + ['ofn'])
+  cmd.run(cmd.prefix)
+  puts cmd.save_command
+end

data/processor/command/set_subcmd/auto_subcmd/eval.rb

@@ -4,6 +4,7 @@ require_relative '../../base/subsubcmd'
 
 class Trepan::SubSubcommand::SetAutoEval < Trepan::SetBoolSubSubcommand
   unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = "Evaluate unrecognized debugger commands.
 
 Often inside the debugger, one would like to be able to run arbitrary
@@ -35,8 +36,6 @@ problem. Another possibility is to go into a real Ruby shell via the
 'irb' command.
 "
     MIN_ABBREV = 'ev'.size
-    NAME       = File.basename(__FILE__, '.rb')
-    PREFIX     = %W(set auto #{NAME})
     SHORT_HELP = "Set evaluation of unrecognized debugger commands"
   end
 

data/processor/command/set_subcmd/auto_subcmd/irb.rb

@@ -1,13 +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::Subcommand::SetAutoIrb < Trepan::SetBoolSubSubcommand
   unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = "Set to automatically go into irb each time we enter the debugger"
     MIN_ABBREV = 'ir'.size
-    NAME       = File.basename(__FILE__, '.rb')
-    PREFIX     = %W(set auto #{NAME})
   end
 
   def run(args)

data/processor/command/set_subcmd/auto_subcmd/list.rb

@@ -1,13 +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::Subcommand::SetAutoList < Trepan::SetBoolSubSubcommand
   unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = "Set to run a 'list' command each time we enter the debugger"
     MIN_ABBREV = 'l'.size
-    NAME       = File.basename(__FILE__, '.rb')
-    PREFIX     = %w(set auto list)
     SHORT_HELP = "Set running a 'list' command each time we enter the debugger"
   end
 

data/processor/command/set_subcmd/highlight.rb

@@ -5,13 +5,19 @@ 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 highlight highlighting'
+    HELP       = 'Set whether we use terminal highlighting'
     IN_LIST    = true
-    MIN_ABBREV = 'ba'.size
+    MIN_ABBREV = 'hi'.size
   end
+
+  def complete(prefix)
+    Trepan::Complete.complete_token(%w(on off reset), prefix)
+  end
+
   def run(args)
     if args.size == 3 && 'reset' == args[2]
       LineCache::clear_file_format_cache
+      @proc.settings[:highlight] = :term 
     else
       super
       @proc.settings[:highlight] = :term if @proc.settings[:highlight]

data/processor/command/set_subcmd/reload.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::SetReload < Trepan::SetBoolSubcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    SHORT_HELP = "Set whether to reread source text when it changes."
+    IN_LIST    = true
+    MIN_ABBREV = 're'.size
+    HELP         = <<-EOH
+#{CMD} {on|off}
+
+Source text is cached on the first read. This ensures that if you
+change the source text after the debugged program is runnning you will
+still see the source code as pertains to the running program rather
+than what is in the filesystem.
+
+However sometimes this may not be what you want. In particular in running
+Ruby on Rails in development, Rails will also detect file changes and
+will reload the source code. So here the debugger will be out of sync.
+
+Set this to true, and the debugger will notice such changes and reread
+the source text when it discovers it has changed.
+
+See also "info source" and "info files" and note the SHA1
+and file modification time.
+    EOH
+  end
+end
+
+if __FILE__ == $0
+  # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this agin
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::SetReload, false)
+  cmd.run(cmd.prefix + ['off'])
+  cmd.run(cmd.prefix + ['ofn'])
+  cmd.run(cmd.prefix)
+  puts cmd.save_command
+end

data/processor/command/set_subcmd/timer.rb

@@ -5,7 +5,8 @@ require_relative '../base/subsubcmd'
 class Trepan::Subcommand::SetTimer < Trepan::SetBoolSubcommand
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP = "set timer [on|off|0|1]
+    HELP         = <<-EOH
+#{PREFIX.join(' ')} [on|off]
 
 Tracks and shows elapsed time between debugger events.
 
@@ -24,7 +25,7 @@ Buy turning this setting on, you may be able to get a feel for what
 how expensive the various settings.
 
 See also: 'set events', 'set trace buffer', 'step', and 'break'.
-"
+    EOH
 
     MIN_ABBREV = 'ti'.size
     SHORT_HELP = "Set to show elapsed time between debugger events"
@@ -46,22 +47,11 @@ end
 if __FILE__ == $0
   # Demo it.
   require_relative '../../mock'
-  require_relative '../../subcmd'
   require_relative '../../hook'
-  name = File.basename(__FILE__, '.rb')
-
-  # FIXME: DRY the below code
-  dbgr, set_cmd = MockDebugger::setup('set')
-  subcommand    = Trepan::Subcommand::SetTimer.new(set_cmd)
-  testcmdMgr = Trepan::Subcmd.new(subcommand)
-
-  subcommand.run_show_bool
-  subcommand.summary_help(name)
-
-  # require 'trepanning'
-  # Trepan.debug
-  subcommand.run(['set', name])
-  subcommand.run(['set', name, 'off'])
-  subcommand.run(['set', name, 'on'])
 
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::SetTimer)
+  cmd.run(cmd.prefix)
+  %w(off on).each do |arg|
+    cmd.run(cmd.prefix + [arg])
+  end
 end

data/processor/command/set_subcmd/trace.rb

@@ -8,8 +8,8 @@ class Trepan::SubSubcommand::SetTrace < Trepan::SubSubcommandMgr
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP = "Set tracing of various sorts.
 
-The types of tracing include global variables, events from the trace
-buffer, or printing those events.
+The types of tracing include events from the trace buffer, or printing
+those events.
 
 See 'help #{PREFIX.join(' ')} *' for a list of subcommands or 'help set trace
 <name>' for help on a particular trace subcommand."

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

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../../base/subsubcmd'
-require_relative '../trace'
+
 class Trepan::SubSubcommand::SetTraceBuffer < Trepan::SetBoolSubSubcommand
-  Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
   unless defined?(HELP)
+    Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
     HELP         = <<-EOH
 #{CMD} [on|off|1|0]
 

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

@@ -1,12 +1,12 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../../base/subsubcmd'
-require_relative '../trace'
+
 class Trepan::SubSubcommand::SetTracePrint < Trepan::SetBoolSubSubcommand
-  Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
   unless defined?(HELP)
+    Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
     HELP         = <<-EOH
-"#{CMD} [on|off|1|0]
+#{CMD} [on|off|1|0]
 
 Set printing trace events.
     EOH

data/processor/command/{irb.rb → shell.rb}

@@ -1,13 +1,15 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'irb'
 require_relative 'base/cmd'
 require_relative '../../app/irb'
 class Trepan::Command::IRBCommand < Trepan::Command
 
   unless defined?(HELP)
-    NAME         = File.basename(__FILE__, '.rb')
+    NAME = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
-#{NAME} [-d]\tstarts an Interactive Ruby (IRB) session.
+#{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. 
@@ -32,9 +34,10 @@ Here then is a loop to query VM stack values:
   (-1..1).each {|i| dbgr(\"info reg sp \#{i}\")}
      HELP
 
-    CATEGORY     = 'support'
-    MAX_ARGS     = 1  # Need at most this many
-    SHORT_HELP  = "Run #{NAME} as a command subshell"
+    ALIASES    = %w(irb)
+    CATEGORY   = 'support'
+    MAX_ARGS   = 1  # Need at most this many
+    SHORT_HELP = "Run #{NAME} as a command subshell"
   end
 
   # This method runs the command

data/processor/command/show_subcmd/abbrev.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::ShowAbbrev < Trepan::ShowBoolSubcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP       = "Show whether we allow abbreviate debugger command names"
+    MIN_ABBREV = 'ab'.size
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  $0 = __FILE__ + 'notagain' # So we don't run this agin
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::ShowAbbrev)
+end

data/processor/command/show_subcmd/directories.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative '../base/subcmd'
+
+class Trepan::Subcommand::ShowDirectories < Trepan::Subcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = "Show current search path for finding source files"
+    MIN_ABBREV   = 'dir'.size
+  end
+
+  def run(args)
+    msg "Source directories searched: #{settings[:directory]}"
+  end
+end
+
+if __FILE__ == $0 && caller.size == 0 
+  # Demo it.
+  require_relative '../../mock'
+  cmd = MockDebugger::sub_setup(Trepan::Subcommand::ShowDirectories)
+end