rb8-trepanning 0.1.3

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

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::SetMaxList < Trepan::SubSubcommand
+  unless defined?(HELP)
+    HELP         = 'Set max[imum] list NUMBER
+
+Set number of source-code lines to list by default.'
+    IN_LIST      = true
+    MIN_ABBREV   = 'lis'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    PREFIX       = %w(set max list)
+    SHORT_HELP   = 'Set number of lines to list'
+  end
+
+  def run(args)
+    args.shift
+    run_set_int(args.join(' '),
+                "The '#{PREFIX.join(' ')}' command requires a list size", 
+                0, nil)
+  end
+
+  alias save_command save_command_from_settings
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+
+  dbgr, set_cmd = MockDebugger::setup('set', false)
+  max_cmd       = Trepan::SubSubcommand::SetMax.new(dbgr.processor, 
+                                                      set_cmd)
+  cmd_ary       = Trepan::SubSubcommand::SetMaxWidth::PREFIX
+  cmd_name      = cmd_ary.join('')
+  subcmd        = Trepan::SubSubcommand::SetMaxList.new(set_cmd.proc,
+                                                        max_cmd,
+                                                        cmd_name)
+  prefix_run = cmd_ary[1..-1]
+  subcmd.run(prefix_run)
+  subcmd.run(prefix_run + %w(0))
+  subcmd.run(prefix_run + %w(20))
+  subcmd.summary_help(subcmd.name)
+  puts
+  puts '-' * 20
+  puts subcmd.save_command
+end

data/processor/command/set_subcmd/max_subcmd/stack.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::Subcommand::SetMaxStack < Trepan::SubSubcommand
+  unless defined?(HELP)
+    HELP         = 'Set number of backtrace lines the debugger will show'
+    DEFAULT_MIN  = 3
+    MIN_ABBREV   = 'sta'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    PREFIX       = %w(set max stack)
+  end
+
+  def run(args)
+    args.shift
+    args = %W(#{DEFAULT_MIN}) if args.empty?
+    run_set_int(args.join(' '),
+                "The '#{PREFIX.join(' ')}' command requires a list size", 
+                DEFAULT_MIN, nil)
+  end
+
+  alias save_command save_command_from_settings
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  dbgr, set_cmd = MockDebugger::setup('set')
+  name = File.basename(__FILE__, '.rb')
+
+  dbgr, set_cmd = MockDebugger::setup('set')
+  max_cmd       = Trepan::SubSubcommand::SetMax.new(dbgr.processor, 
+                                                      set_cmd)
+  cmd_ary       = Trepan::SubSubcommand::SetMaxStack::PREFIX
+  cmd_name      = cmd_ary.join('')
+  subcmd        = Trepan::SubSubcommand::SetMaxStack.new(set_cmd.proc,
+                                                         max_cmd,
+                                                         cmd_name)
+  prefix_run = cmd_ary[1..-1]
+  subcmd.run(prefix_run)
+  subcmd.run(prefix_run + %w(0))
+  subcmd.run(prefix_run + %w(20))
+  name = File.basename(__FILE__, '.rb')
+  subcmd.summary_help(name)
+  puts
+  puts '-' * 20
+  puts subcmd.save_command
+end

data/processor/command/set_subcmd/max_subcmd/string.rb

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::SetMaxString < Trepan::SubSubcommand
+  unless defined?(HELP)
+    NAME         = File.basename(__FILE__, '.rb')
+    # FIXME: DRY the next two lines and throw in "set" too.
+    dirname      = File.basename(File.dirname(File.expand_path(__FILE__)))
+    PREFIX       = %W(set #{dirname[0...-'_subcmd'.size]} #{NAME})
+    DEFAULT_MIN  = 10
+    DEFAULT_LENGTH  = 80
+
+    HELP         = <<-EOH
+
+#{PREFIX.join(' ')} [NUM]
+
+Sometimes the string representation of an object is very long. This
+setting limits how much of the string representation you want to
+see. 
+
+NUM must have a value at least #{DEFAULT_MIN}. If no value is supplied
+#{DEFAULT_LENGTH} is used.
+
+To disable any limit on the string size, use a negative number.
+
+If the string has an embedded newline then we will assume the output
+is intended to be formated as is.
+
+Examples:
+  #{PREFIX.join(' ')} #{DEFAULT_LENGTH}  # set maximum string length to 80
+  #{PREFIX.join(' ')} # same as above
+  #{PREFIX.join(' ')} -1  # set unlimited maximum string
+  #{PREFIX.join(' ')} -10 # same as above
+  #{PREFIX.join(' ')} #{DEFAULT_MIN-1} # invalid - number too small.
+
+EOH
+    MIN_ABBREV   = 'str'.size
+    SHORT_HELP   = "Set maximum # chars in a string before truncation"
+  end
+
+  def run(args)
+    args.shift
+    args = %W(#{DEFAULT_LENGTH}) if args.empty?
+    run_set_int(args.join(' '),
+                "The 'set maximum string' command requires number at least #{DEFAULT_MIN}", 
+                DEFAULT_MIN, nil)
+  end
+
+  alias save_command save_command_from_settings
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  # FIXME: DRY this code.
+  dbgr, set_cmd = MockDebugger::setup('set')
+  max_cmd       = Trepan::SubSubcommand::SetMax.new(dbgr.processor, 
+                                                    set_cmd)
+  cmd_name      = Trepan::SubSubcommand::SetMaxString::PREFIX.join('')
+  name          = Trepan::SubSubcommand::SetMaxString::PREFIX[0]
+  subcmd        = Trepan::SubSubcommand::SetMaxString.new(set_cmd.proc, 
+                                                          max_cmd,
+                                                          cmd_name)
+  subcmd.run([])
+  subcmd.run(%W(#{name} 0))
+  subcmd.run(%W(#{name} 20))
+  subcmd.run(%W(#{name} 100))
+  name = File.basename(__FILE__, '.rb')
+  subcmd.summary_help(name)
+  puts
+  puts '-' * 20
+  puts subcmd.save_command
+end

data/processor/command/set_subcmd/max_subcmd/width.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::SetMaxWidth < Trepan::SubSubcommand
+  unless defined?(HELP)
+    HELP         = 'Set max[imum] width NUMBER
+
+Set number of characters the debugger thinks are in a line.'
+    IN_LIST      = true
+    MIN_ABBREV   = 'wid'.size
+    NAME         = File.basename(__FILE__, '.rb')
+    PREFIX       = %w(set max width)
+    SHORT_HELP   = 'Set number of characters the debugger thinks are in a line'
+  end
+
+  def run(args)
+    args.shift
+    run_set_int(args.join(' '),
+                "The 'width' command requires a line width", 
+                0, nil)
+  end
+
+  alias save_command save_command_from_settings
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  name = File.basename(__FILE__, '.rb')
+
+  dbgr, set_cmd = MockDebugger::setup('set')
+  # max_cmd       = Trepan::SubSubcommand::SetMax.new(dbgr.core.processor, 
+  #                                                     set_cmd)
+  # cmd_name      = Trepan::SubSubcommand::SetMaxWidth::PREFIX.join('')
+  # subcmd        = Trepan::SubSubcommand::SetMaxWidth.new(set_cmd.proc,
+  #                                                        max_cmd,
+  #                                                        cmd_name)
+  # subcmd.run(['max', 'width'])
+  # subcmd.run(%w(set max width 0))
+  # subcmd.run(%w(set max width 20))
+  name = File.basename(__FILE__, '.rb')
+  subcmd.summary_help(name)
+  # puts
+  # puts '-' * 20
+  # puts subcmd.save_command
+end

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

@@ -0,0 +1,37 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../base/subsubcmd'
+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.
+
+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."
+
+    IN_LIST    = true
+    MIN_ABBREV = 'tr'.size
+    SHORT_HELP = 'Set tracing of various sorts.'
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../mock'
+  dbgr, cmd = MockDebugger::setup('set')
+  # cmds = dbgr.core.processor.commands
+  # set_cmd = cmds['set']
+  # command = Trepan::SubSubcommand::SetTrace.new(dbgr.core.processor, 
+  #                                              set_cmd)
+  # set_cmd.instance_variable_set('@last_args', command.class.const_get('CMD'))
+  # # require_relative '../../../lib/trepanning'
+  # # Trepan.debug
+  # command.run(command.class.const_get('PREFIX'))
+end

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

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::SetTraceBuffer < Trepan::SetBoolSubSubcommand
+  unless defined?(HELP)
+    Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
+    HELP         = <<-EOH
+#{CMD} [on|off|1|0]
+
+Set saving trace events in a buffer
+    EOH
+    MIN_ABBREV   = 'b'.size  
+    SHORT_HELP   = 'Set saving trace events in a buffer'
+  end
+
+  def run(args)
+    super
+    if settings[:tracebuffer]
+      # @proc.start_capture
+      @proc.unconditional_prehooks.insert_if_new(-1, *@proc.tracebuf_hook)
+    else
+      @proc.unconditional_prehooks.delete_by_name('tracebuffer')
+      # @proc.stop_capture
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  require_relative '../trace'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::SetTrace,
+                                   Trepan::SubSubcommand::SetTraceBuffer)
+  %w(off on 1 0).each do |arg|
+      cmd.run([cmd.name, arg])
+  end
+  puts cmd.save_command()
+end
+

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

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require 'rubygems'; require 'require_relative'
+require_relative '../../base/subsubcmd'
+
+class Trepan::SubSubcommand::SetTracePrint < Trepan::SetBoolSubSubcommand
+  unless defined?(HELP)
+    Trepanning::SubSubcommand.set_name_prefix(__FILE__, self)
+    HELP         = <<-EOH
+#{CMD} [on|off|1|0]
+
+Set printing trace events.
+    EOH
+
+    MIN_ABBREV   = 'p'.size  
+    SHORT_HELP   = 'Set print trace events'
+  end
+
+  def run(args)
+    super
+    if settings[:traceprint]
+      @proc.unconditional_prehooks.insert_if_new(-1, *@proc.trace_hook)
+    else
+      @proc.unconditional_prehooks.delete_by_name('trace')
+    end
+  end
+
+end
+
+if __FILE__ == $0
+  # Demo it.
+  require_relative '../../../mock'
+  require_relative '../trace'
+  cmd = MockDebugger::subsub_setup(Trepan::SubSubcommand::SetTrace,
+                                   Trepan::SubSubcommand::SetTracePrint)
+  %w(off on 1 0).each do |arg|
+      cmd.run([cmd.name, arg])
+  end
+  puts cmd.save_command()
+end
+