rbx-trepanning 0.0.8-universal-rubinius-1.2 → 0.1.0-universal-rubinius-1.2

data/processor/command/macro.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../eval'
 class Trepan::Command::MacroCommand < Trepan::Command
 
@@ -11,26 +11,44 @@ class Trepan::Command::MacroCommand < Trepan::Command
 #{NAME} MACRO-NAME PROC-OBJECT
 
 Define MACRO-NAME as a debugger macro. Debugger macros get a list of
-arguments. 
+arguments. Debugger macros get a list of arguments which you supply
+without parenthesis or commas. See below for an example.
 
-The macro should return either a String or an Array of Strings which
-is substituted for the command.  If the return is a String, that gets
-tokenized by a simple String#split .  Note that macro processing is
-done right after splitting on ;; so if the macro returns a string
-containing ;; this will not be handled on the string returned.
+The macro (really a Ruby Proc) should return either a String or an
+Array of Strings. The string in both cases are strings of debugger
+commands.  If the return is a String, that gets tokenized by a simple
+String#split .  Note that macro processing is done right after
+splitting on ;; so if the macro returns a string containing ;; this
+will not be handled on the string returned.
 
 If instead, Array of Strings is returned, then the first string is
-unshifted from the array and executed. The remaning strings are pushed
+shifted from the array and executed. The remaining strings are pushed
 onto the command queue. In contrast to the first string, subsequent
 strings can contain other macros, and ;; in those strings will be
 split into separate commands.
 
-Here is an example. The below creates a macro called finish+ which
+Here is an example. The below creates a macro called fin+ which
 issues two commands 'finish' followed by 'step':
 
   macro fin+ Proc.new{|*args| %w(finish step)}
 
-See also 'show macro'.
+If you wanted to parameterize the argument of the 'finish' command
+you could do that this way:
+
+  macro fin+ Proc.new{|*args| ['finish \#{args[0]}' 'step']}
+
+Invoking with 
+  fin+ 3
+
+would expand to ["finish 3", "step"]
+
+If you were to add another parameter for 'step', the note that the 
+invocation might be 
+  fin+ 3 2
+
+rather than 'fin+(3,2)' or 'fin+ 3, 2'.
+
+See also 'info macro'.
     HELP
 
     CATEGORY      = 'support'

data/processor/command/next.rb

@@ -1,5 +1,5 @@
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../stepping'
 require_relative '../../app/breakpoint'
 
@@ -42,6 +42,7 @@ See also 'step' and 'nexti'.
     end
 
     @proc.step('next', step_count)
+    # @proc.next(step_count)
   end
   
 end

data/processor/command/nexti.rb

@@ -1,5 +1,5 @@
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../stepping'
 require_relative '../../app/breakpoint'
 require_relative '../../app/iseq'

data/processor/command/parsetree.rb

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require 'pp'
+require_relative '../command'
+require_relative '../../app/cmd_parse'
+class Trepan::Command::ParseTreeCommand < Trepan::Command
+  
+  unless defined?(HELP)
+    NAME = File.basename(__FILE__, '.rb')
+    HELP = <<-HELP
+#{NAME} [FILE]
+#{NAME} 
+
+In the first form, print a ParseTree S-expression of the current file
+or FILE.
+HELP
+      
+    # ALIASES       = %w(p)
+    MAX_ARGS      = 1
+    CATEGORY      = 'data'
+    SHORT_HELP    = 'PrettyPrint a ParseTree S-expression for a file'
+  end
+  
+  def run(args)
+    meth = nil
+    case args.size
+    when 1
+      file = @proc.frame.file
+    when 2
+      file = args[1]
+    else
+      errmsg 'Expecting a file name'
+    end
+    expanded_file = @proc.canonic_file(file)
+    if File.readable?(expanded_file)
+      section "ParseTree for file: #{expanded_file}"
+      msg File.to_sexp(expanded_file).pretty_inspect
+    else
+      errmsg "File #{expanded_file} is not readable."
+    end
+  end
+  
+  if __FILE__ == $0
+    require 'pp'
+    require_relative '../mock'
+    dbgr, cmd = MockDebugger::setup
+    cmd.run([cmd.name, __FILE__])
+  end
+  
+end

data/processor/command/pr.rb

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

data/processor/command/ps.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../eval'
 class Trepan::Command::PsCommand < Trepan::Command
 

data/processor/command/restart.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../../app/run'
 class Trepan::Command::RestartCommand < Trepan::Command
 

data/processor/command/save.rb

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

data/processor/command/server.rb

@@ -2,7 +2,7 @@
 # Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'optparse'
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
+require_relative '../command'
 require_relative '../../app/default'
 require_relative '../../interface/server'   # server interface (remote debugging)
 class Trepan::Command::ServerCommand < Trepan::Command

data/processor/command/set_subcmd/abbrev.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+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.rb

@@ -6,8 +6,14 @@ require_relative '../base/subsubmgr'
 
 class Trepan::SubSubcommand::SetAuto < Trepan::SubSubcommandMgr
   unless defined?(HELP)
-    HELP   = 'Set controls for things with some sort of "automatic" default behavior'
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP   = <<-EOH
+Set controls for things with some sort of "automatic" default behavior.
+
+See "#{PREFIX.join(' ')} *" for a list of subcommands or "#{PREFIX.join(' ')} <name>" 
+for help on a particular trace subcommand.
+    EOH
+    SHORT_HELP = 'Set controls for some "automatic" default behaviors';
   end
 end
 

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

@@ -5,6 +5,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
@@ -36,8 +37,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,14 +1,13 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 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 irb)
   end
 
   def run(args)

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

@@ -1,14 +1,13 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'rubygems'; require 'require_relative'
 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/different.rb

@@ -9,7 +9,7 @@ class Trepan::Subcommand::SetDifferent < Trepan::SetBoolSubcommand
     HELP         = <<-EOH
 #{PREFIX.join(' ')} [on|off|nostack]
 
-Set to make sure 'next/step' move to a new position.
+Set to make sure 'next' or 'step' moves to a new position.
 
 Due to the interpretive, expression-oriented nature of the Ruby
 Language and implementation, each line often may contain many possible

data/processor/command/set_subcmd/highlight.rb

@@ -8,11 +8,17 @@ class Trepan::Subcommand::SetHighlight < Trepan::SetBoolSubcommand
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     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,42 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+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

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subsubcmd'
+
+class Trepan::Subcommand::SetTimer < Trepan::SetBoolSubcommand
+  unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
+    HELP         = <<-EOH
+#{PREFIX.join(' ')} [on|off]
+
+Tracks and shows elapsed time between debugger events.
+
+Since debugger overhead can be large depending on what you are doing,
+there are many ways to customize the debugger to take less time (and
+do less).
+
+Stepping is slow, running to a breakpoint without stepping is
+relatively fast compared to previous versions of the debugger and
+compared to stepping. 
+
+Stopping at fewer events can also speed things up. Trace event
+buffering slows things down.
+
+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"
+  end
+
+  def run(args)
+    super
+    if @proc.settings[:timer]
+      @proc.cmdloop_posthooks.insert_if_new(-1, 'timer', @proc.timer_hook[1])
+      @proc.cmdloop_prehooks.insert_if_new(-1, 'timer', @proc.timer_hook[1])
+    else
+      @proc.cmdloop_posthooks.delete_by_name('timer')
+      @proc.cmdloop_prehooks.delete_by_name('timer')
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  require_relative '../../hook'
+
+  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

@@ -7,14 +7,15 @@ require_relative '../base/subsubmgr'
 class Trepan::SubSubcommand::SetTrace < Trepan::SubSubcommandMgr 
   unless defined?(HELP)
     Trepanning::Subcommand.set_name_prefix(__FILE__, self)
-    HELP = "Set tracing of various sorts.
+    HELP = <<-EOH
+Set tracing of various sorts.
 
 The types of tracing include global variables, 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."
-
+<name>' for help on a particular trace subcommand.
+    EOH
     IN_LIST    = true
     MIN_ABBREV = 'tr'.size
     SHORT_HELP = 'Set tracing of various sorts.'

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

@@ -1,17 +1,19 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require 'irb'
 require 'rubygems'; require 'require_relative'
-require_relative 'base/cmd'
-require_relative '../../app/irb'
+require_relative '../command'
 class Trepan::Command::IRBCommand < Trepan::Command
 
   unless defined?(HELP)
+    require_relative '../../app/irb'
     NAME = File.basename(__FILE__, '.rb')
-    HELP = <<-HELP 
-#{NAME} [-d]\tstarts an Interactive Ruby (IRB) session.
+    HELP = <<-HELP
+#{NAME} [-d]
+
+starts an Interactive Ruby (IRB) session.
 
 If -d is added you can get access to debugger frame the global variables
-$trepanx_frame and $trepanx_cmdproc. 
+$trepan_frame and $trepan_cmdproc. 
 
 #{NAME} is extended with methods 'cont', 'ne', and, 'q', 'step' which 
 run the corresponding debugger commands 'continue', 'next', 'exit' and 'step'. 
@@ -33,9 +35,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
@@ -53,17 +56,17 @@ Here then is a loop to query VM stack values:
     # end
 
     save_trap = trap('SIGINT') do
-      throw :IRB_EXIT, :cont if $trepanx_in_irb
+      throw :IRB_EXIT, :cont if $trepan_in_irb
     end
 
-    $trepanx = @proc.dbgr 
+    $trepan = @proc.dbgr 
     if add_debugging
-      $trepanx_cmdproc  = @proc
-      $trepanx_frame    = @proc.frame
+      $trepan_cmdproc  = @proc
+      $trepan_frame    = @proc.frame
     end
-    $trepanx_in_irb = true
-    $trepanx_irb_statements = nil
-    $trepanx_command = nil
+    $trepan_in_irb = true
+    $trepan_irb_statements = nil
+    $trepan_command = nil
 
     conf = {:BACK_TRACE_LIMIT => settings[:maxstack],
             :RC => true}
@@ -105,16 +108,16 @@ Here then is a loop to query VM stack values:
     when :finish
       @proc.finish 
     when :next
-      @proc.next # (1, {})
+      @proc.step ('next', 1, {})
     when :quit
       @proc.quit
     when :step
-      @proc.step # (1, {})
+      @proc.step ('step', 1, {})
     else
       @proc.print_location
     end
   ensure
-    $trepanx_in_irb = false
+    $trepan_in_irb = false
     # restore old trap if any
     trap('SIGINT', save_trap) if save_trap
   end