trepanning 0.0.9 → 0.1.0

data/lib/trepanning.rb

@@ -6,6 +6,8 @@ require_relative '../app/core'           # core event-handling mechanism
 require_relative '../app/default'        # default debugger settings
 require_relative '../interface/user'     # user interface (includes I/O)
 require_relative '../interface/script'   # --command interface (includes I/O)
+require_relative '../interface/client'   # client interface (remote debugging)
+require_relative '../interface/server'   # server interface (remote debugging)
 
 # SCRIPT_ISEQS__ is like SCRIPT_LINES__ in a patched Ruby 1.9. Setting
 # this variable to a hash causes instruction sequences to be added in
@@ -20,7 +22,6 @@ ISEQS__        = {} unless
   defined?(ISEQS__) && ISEQS__.is_a?(Hash)
 
 class Trepan
-  VERSION = '0.0.9'
 
   attr_accessor :core         # access to Trepan::Core instance
   attr_accessor :intf         # Array. The way the outside world
@@ -40,40 +41,56 @@ class Trepan
     th = Thread.current
     th.exec_event_tracing  = true
 
-    @settings = Trepanning::DEFAULT_SETTINGS.merge(settings)
-    @input  ||= @settings[:input]
-    @output ||= @settings[:output]
+    @settings = Trepan::DEFAULT_SETTINGS.merge(settings)
+    @input  = @settings[:input] || STDIN
+    @output = @settings[:output] || STDOUT
 
-    @intf     = [Trepan::UserInterface.new(@input, @output)]
-    @settings[:cmdfiles].each do |cmdfile|
-      add_command_file(cmdfile)
-    end if @settings.member?(:cmdfiles)
-    @core     = Core.new(self, @settings[:core_opts])
+    @intf = 
+      if @settings[:server]
+        opts = Trepan::ServerInterface::DEFAULT_INIT_CONNECTION_OPTS.dup
+        opts[:port] = @settings[:port] if @settings[:port]
+        opts[:host] = @settings[:host] if @settings[:host]
+        puts("starting debugger in out-of-process mode port at " +
+             "#{opts[:host]}:#{opts[:port]}")
+        [Trepan::ServerInterface.new(nil, nil, opts)]
+      elsif @settings[:client]
+        opts = Trepan::ClientInterface::DEFAULT_INIT_CONNECTION_OPTS.dup
+        opts[:port] = @settings[:port] if @settings[:port]
+        opts[:host] = @settings[:host] if @settings[:host]
+        [Trepan::ClientInterface.new(nil, nil, nil, nil, opts)]
+      else
+        [Trepan::UserInterface.new(@input, @output)]
+      end
+
+    process_cmdfile_setting(@settings)
+
+    # FIXME: The below option settings is a big crock.
+    @settings[:core_opts][:cmdproc_opts] ||= {}
+    @settings[:core_opts][:cmdproc_opts][:highlight] ||= settings[:highlight]
+
+    @core = Core.new(self, @settings[:core_opts])
+    
     if @settings[:initial_dir]
       Dir.chdir(@settings[:initial_dir])
     else
       @settings[:initial_dir] = Dir.pwd
     end
     @initial_dir  = @settings[:initial_dir]
-    @restart_argv = 
-      if @settings[:set_restart]
-        [File.expand_path($0)] + ARGV
-      elsif @settings[:restart_argv]
-        @settings[:restart_argv]
-      else 
-        nil
+    @restart_argv = @settings[:restart_argv]
+
+    unless @settings[:client]
+      @trace_filter = Trace::Filter.new
+      %w(debugger start stop).each do |m| 
+        @trace_filter << self.method(m.to_sym)
       end
-    @trace_filter = Trace::Filter.new
-    %w(debugger start stop).each do |m| 
-      @trace_filter << self.method(m.to_sym)
-    end
-    %w(debugger event_processor trace_var_processor).each do 
-      |m| 
-      @trace_filter << @core.method(m)
+      %w(debugger event_processor trace_var_processor).each do 
+        |m| 
+        @trace_filter << @core.method(m)
+      end
+      @trace_filter << @trace_filter.method(:add_trace_func)
+      @trace_filter << @trace_filter.method(:remove_trace_func)
+      @trace_filter << Kernel.method(:add_trace_func)
     end
-    @trace_filter << @trace_filter.method(:add_trace_func)
-    @trace_filter << @trace_filter.method(:remove_trace_func)
-    @trace_filter << Kernel.method(:add_trace_func)
 
     # Run user debugger command startup files.
     add_startup_files unless @settings[:nx]
@@ -185,8 +202,8 @@ class Trepan
 
   def add_startup_files()
     seen = {}
-    cwd_initfile = File.join('.', Trepanning::CMD_INITFILE_BASE)
-    [cwd_initfile, Trepanning::CMD_INITFILE].each do |initfile|
+    cwd_initfile = File.join('.', Trepan::CMD_INITFILE_BASE)
+    [cwd_initfile, Trepan::CMD_INITFILE].each do |initfile|
       full_initfile_path = File.expand_path(initfile)
       next if seen[full_initfile_path]
       add_command_file(full_initfile_path) if File.readable?(full_initfile_path)
@@ -194,6 +211,18 @@ class Trepan
     end
   end
 
+  def process_cmdfile_setting(settings)
+    settings[:cmdfiles].each do |item|
+      cmdfile, opts = 
+        if item.kind_of?(Array)
+          item
+        else
+          [item, {}]
+        end
+      add_command_file(cmdfile, opts)
+    end if settings.member?(:cmdfiles)
+  end
+
   # As a simplification for creating a debugger object, and then
   # calling using the object to invoke the debugger, we allow this
   # two-step process in one step. That is, instead of

data/processor/command/base/cmd.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>
 # 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 
@@ -46,21 +46,21 @@ class Trepan
       @proc.confirm(message, default)
     end
 
-    def errmsg(message)
-      @proc.errmsg(message)
+    def errmsg(message, opts={})
+      @proc.errmsg(message, opts)
     end
 
     def obj_const(obj, name)
       obj.class.const_get(name) 
     end
 
-    def msg(message)
-      @proc.msg(message)
+    def msg(message, opts={})
+      @proc.msg(message, opts)
     end
 
     # Convenience short-hand for @dbgr.intf[-1].msg_nocr
     def msg_nocr(msg)
-      @proc.msg_nocr(msg)
+      @proc.msg_nocr(msg, opts={})
     end
 
     def my_const(name)
@@ -86,6 +86,10 @@ class Trepan
       raise RuntimeError, 'You need to define this method elsewhere'
     end
 
+    def section(message, opts={})
+      @proc.section(message, opts)
+    end
+
     def settings
       @proc.settings
     end

data/processor/command/base/subcmd.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>
 # A base class for debugger subcommands.
 #
 # Note: don't end classname with Command (capital C) since main
@@ -193,6 +193,18 @@ class Trepan
 
 end
 
+module Trepanning
+  module Subcommand
+    module_function
+    def set_name_prefix(__file__, klass)
+      dirname    = File.basename(File.dirname(File.expand_path(__file__)))
+      name = File.basename(__file__, '.rb')
+      klass.const_set('NAME', name)
+      klass.const_set('PREFIX', %W(#{dirname[0...-'_subcmd'.size]} #{name}))
+    end
+  end
+end
+
 if __FILE__ == $0
   # Demo it.
   require_relative '../../mock'

data/processor/command/directory.rb

@@ -8,22 +8,30 @@ class Trepan::Command::DirectoryCommand < Trepan::Command
     MAX_ARGS     = 1  # Need at most this many
     NAME         = File.basename(__FILE__, '.rb')
     HELP = <<-HELP
+#{NAME} [DIR]
+
 Add directory DIR to beginning of search path for source files.
 DIR can also be $cwd for the current working directory, or $cdir for the
 directory in which the debugged file start.
 With no argument, reset the search path to $cdir:$cwd, the default.
 
-This command may be useful for debugging into Rubinius methods such as
-kernel/common/module.rb if have the source code somewhere.
+This command may be useful if for some reason the debugger can't find 
+source files because directories have been moved. 
+
+Examples:
+   #{NAME} ~/.rvm/src/ruby-head  # Adds an rvm-like directory to path
+   #{NAME} # reset to $cdir:$cwd
       HELP
+
     SHORT_HELP  = 
       'Add directory DIR to beginning of search path for source files'
   end
     
   # This method runs the command
-  def run(args)
+  def run(args) # :nodoc
     if args.size > 1
-      settings[:directory] = "#{args[1]}:#{settings[:directory]}"
+      path = File.expand_path(args[1])
+      settings[:directory] = "#{path}:#{settings[:directory]}"
       msg "Source directories searched: #{settings[:directory]}"
     else
       if confirm('Reintialize source path to empty?', false)
@@ -36,8 +44,7 @@ end
 
 if __FILE__ == $0
   require_relative '../mock'
-  name = File.basename(__FILE__, '.rb')
-  dbgr, cmd = MockDebugger::setup(name)
-  cmd.run([name])
-  cmd.run([name, '/tmp'])
+  dbgr, cmd = MockDebugger::setup
+  cmd.run([cmd.name])
+  cmd.run([cmd.name, '/tmp'])
 end

data/processor/command/disassemble.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/cmd'
 require_relative '../../app/disassemble'
 require_relative '../../app/file'
@@ -43,7 +43,8 @@ Examples:
       ary = mark_disassembly(iseq.disasm_nochildren, 
                              @proc.frame.iseq.equal?(iseq),
                              @proc.frame.pc_offset,
-                             iseq.brkpts, settings[:maxwidth])
+                             iseq.brkpts, settings[:maxwidth], 
+                             settings[:highlight])
       msg ary
     end
   end

data/processor/command/help.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'
 class Trepan::Command::HelpCommand < Trepan::Command
 
@@ -41,13 +41,15 @@ See also 'examine' and 'whatis'.
 
   # List the command categories and a short description of each.
   def list_categories
-    msg("Classes of commands:")
+    section 'Classes of commands:'
     CATEGORIES.keys.sort.each do |cat|
       msg("%-13s -- %s" % [cat, CATEGORIES[cat]])
     end
     final_msg = '
 Type "help" followed by a class name for a list of commands in that class.
+Type "help syntax" for information on debugger command syntax.
 Type "help *" for the list of all commands.
+Type "help all" for the list of all commands.
 Type "help REGEXP" for the list of commands matching /^#{REGEXP}/
 Type "help CLASS *" for the list of all commands in class CLASS.
 Type "help" followed by command name for full documentation.
@@ -56,12 +58,18 @@ Type "help" followed by command name for full documentation.
   end
 
   # This method runs the command
-  def run(args)
+  def run(args) # :nodoc
     if args.size > 1
       cmd_name = args[1]
       if cmd_name == '*'
-        msg("All command names:")
+        section 'All command names:'
         msg columnize_commands(@proc.commands.keys.sort)
+      elsif cmd_name =~ /^syntax$/i
+        show_command_syntax
+      elsif cmd_name =~ /^all$/i
+        CATEGORIES.sort.each do |category|
+          show_category(category[0], [])
+        end
       elsif CATEGORIES.member?(cmd_name)
         show_category(args[1], args[2..-1])
       elsif @proc.commands.member?(cmd_name) or @proc.aliases.member?(cmd_name)
@@ -87,37 +95,82 @@ Type "help" followed by command name for full documentation.
         if matches.empty?
           errmsg("No commands found matching /^#{cmd_name}/. Try \"help\".")
         else
-          msg("Command names matching /^#{cmd_name}/:")
+          section "Command names matching /^#{cmd_name}/:"
           msg columnize_commands(matches.sort)
         end
       end
     else
       list_categories
     end
-    return false  # Don't break out of cmd loop
   end
 
   # Show short help for all commands in `category'.
   def show_category(category, args)
       
     if args.size == 1 && args[0] == '*'
-      msg("Commands in class %s:" % category)
+      section "Commands in class %s:" % category
       
       cmds = @proc.commands.keys.select do |cmd_name|
         category == @proc.commands[cmd_name].category
       end.sort
-
       width = settings[:maxwidth]
       return columnize_commands(cmds)
     end
         
-    msg("%s." % CATEGORIES[category])
-    msg("List of commands:\n")
+    msg('')
+    section "Command class: %s" % category
+    msg('')
     @proc.commands.keys.sort.each do |name|
       next if category != @proc.commands[name].category
       msg("%-13s -- %s" % [name, @proc.commands[name].short_help])
     end
   end
+
+  def show_command_syntax
+    section "Debugger command syntax"
+    msg <<-EOS
+Command command syntax is very simple-minded. 
+
+If a line starts with #, the command is ignored. 
+If a line starts with !, the line is eval'd. 
+
+If the command you want eval'd uses the Ruby ! initally, add that
+after the first !.
+
+Commands are split at whereever ;; appears. This process disregards
+any quotes or other symbols that have meaning in Ruby. The strings
+after the leading command string are put back on a command queue. 
+
+Within a single command, tokens are then white-space split. Again,
+this process disregards quotes or symbols that have meaning in Ruby.
+
+The first token is then looked up in the debugger command table and
+then the debugger alias table. If a match is found the command name
+and arguments are dispatched to the command object that process the
+command.
+
+If the command is not found and "auto eval" is set on, then the
+command is eval'd in the context that the program is currently stopped
+at. If "auto eval" is not set on, then we display an error message
+that the entered string is "undefined".
+
+If you want irb-like command-processing, it's possible to go into an
+irb shell with the "irb" command. It is also possible to arrange going
+into an irb shell every time you enter the debugger.
+
+Examples:
+
+# This line does nothing. It is a comment
+s    # by default, this is an alias for the "step" command
+!s   # shows the value of variable step. 
+!!s  # Evaluates !s (or "not s"). The first ! is indicates evaluate.
+info program;; list # Runs two commands "info program" and "list"
+pr  "hi ;;-)"  # Syntax error since ;; splits the line and " is not closed.
+!puts "hi ;;-)" # One way to do the above.
+
+See also "alias", "irb", "set auto eval", and "set auto irb".
+    EOS
+  end
 end
 
 if __FILE__ == $0
@@ -125,20 +178,19 @@ if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
 
-  cmd.run %W(cmd.name help)
+  cmd.run %W(#{cmd.name} help)
   puts '=' * 40
-  cmd.run %W(cmd.name *)
+  cmd.run %W(#{cmd.name} *)
   puts '=' * 40
-  cmd.run %W(cmd.name fdafsasfda)
+  cmd.run %W(#{cmd.name} fdafsasfda)
   puts '=' * 40
-  cmd.run %W(cmd.name)
+  cmd.run [cmd.name]
   puts '=' * 40
-  cmd.run %W(cmd.name support)
+  cmd.run %W(#{cmd.name} support)
   puts '=' * 40
-  cmd.run %W(cmd.name support *)
-
+  cmd.run %W(#{cmd.name} support *)
   puts '=' * 40
-  cmd.run %W(cmd.name s.*)
+  cmd.run %W(#{cmd.name} s.*)
   puts '=' * 40
-  cmd.run %W(cmd.name s<>)
+  cmd.run %W(#{cmd.name} s<>)
 end

data/processor/command/info_subcmd/args.rb

@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
 require_relative '../../../app/frame'
 
 class Trepan::Subcommand::InfoArgs < Trepan::Subcommand
   unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP         = 'Show argument variables of the current stack frame'
     MIN_ABBREV   = 'ar'.size 
-    NAME         = File.basename(__FILE__, '.rb')
     NEED_STACK   = true
-    PREFIX       = %w(info args)
   end
 
   include Trepan::Frame

data/processor/command/info_subcmd/breakpoints.rb

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
 require_relative '../base/subcmd'
 
 class Trepan::Subcommand::InfoBreakpoints < Trepan::Subcommand
   unless defined?(HELP)
+    Trepanning::Subcommand.set_name_prefix(__FILE__, self)
     HELP         = <<EOH
 info breakpoints [num1 ...] [verbose]
 
@@ -21,8 +22,6 @@ The "Where" column indicates where the breakpoint is located.
 EOH
 
     MIN_ABBREV   = 'br'.size 
-    NAME         = File.basename(__FILE__, '.rb')
-    PREFIX       = %w(info breakpoints)
     SHORT_HELP = "Status of user-settable breakpoints"
   end