trepanning 0.1.2 → 0.1.3

data/app/options.rb

@@ -8,8 +8,8 @@ require 'optparse'
 class Trepan
   require_relative 'default'
 
-  Trepan::VERSION = '0.1.2'
-  Trepan::PROGRAM = 'trepan'
+  VERSION = '0.1.3'
+  PROGRAM = 'trepan'
 
   def self.show_version
     "#{PROGRAM}, version #{VERSION}"
@@ -31,18 +31,20 @@ class Trepan
     OptionParser.new do |opts|
       opts.banner = <<EOB
 #{show_version}
-Usage: #{PROGRAM} [options] <script.rb> -- <script.rb parameters>
+Usage: #{PROGRAM} [options] [[--] <script.rb> <script.rb parameters>]
 EOB
+      opts.separator ''
+      opts.separator 'Options:'
       opts.on('--client',
-              "Connect to out-of-process program") do
+              'Connect to out-of-process program') do
         if options[:server]
-          stderr.puts "--server option previously given. --client option ignored."
+          stderr.puts '--server option previously given. --client option ignored.'
         else
           options[:client] = true
         end
       end
       opts.on('-c', '--command FILE', String, 
-              "Execute debugger commands from FILE") do |cmdfile| 
+              'Execute debugger commands from FILE') do |cmdfile| 
         if File.readable?(cmdfile)
           options[:cmdfiles] << cmdfile
         elsif File.exists?(cmdfile)
@@ -51,14 +53,7 @@ EOB
           stderr.puts "Command file '#{cmdfile}' does not exist."
         end
       end
-      opts.on('--nx',
-              "Do not run debugger initialization file #{CMD_INITFILE}") do
-        options[:nx] = true
-      end
-      # opts.on('--output FILE', String, "Name of file to record output") do |outfile| 
-      #   options[:outfile] = outfile
-      # end
-      opts.on("--cd DIR", String, "Change current directory to DIR") do |dir| 
+      opts.on('--cd DIR', String, 'Change current directory to DIR') do |dir| 
         if File.directory?(dir)
           if File.executable?(dir)
             options[:chdir] = dir
@@ -69,40 +64,62 @@ EOB
           stderr.puts "\"#{dir}\" is not a directory. Option --cd ignored."
         end
       end
-      opts.on("-h", "--host NAME", String, 
-              "Host or IP used in TCP connections for --server or --client. " + 
+      opts.on('-d', '--debug', "Set $DEBUG=true") {$DEBUG = true}
+      opts.on('--[no-]highlight',
+              'Use [no] syntax highlight output') do |v|
+        options[:highlight] = ((v) ? :term : nil)
+      end
+      opts.on('-h', '--host NAME', String, 
+              'Host or IP used in TCP connections for --server or --client. ' + 
               "Default is #{DEFAULT_SETTINGS[:host].inspect}.") do 
         |name_or_ip| 
         options[:host] = name_or_ip
       end
-      opts.on("-p", "--port NUMBER", Integer, 
-              "Port number used in TCP connections for --server or --client. " + 
+      opts.on('-I', '--include PATH', String, 'Add PATH to $LOAD_PATH') do 
+        |path|
+        $LOAD_PATH.unshift(path)
+      end
+      opts.on('--nx',
+              "Do not run debugger initialization file #{CMD_INITFILE}") do
+        options[:nx] = true
+      end
+      opts.on('-p', '--port NUMBER', Integer, 
+              'Port number used in TCP connections for --server or --client. ' + 
               "Default is #{DEFAULT_SETTINGS[:port]}.") do 
         |num| 
         options[:port] = num
       end
-      opts.on('--server',
-              "Set up for out-of-process debugging") do
+      opts.on('--[no-]readline',
+              'Try [not] GNU Readline') do |v|
+        options[:readline] = v
+      end
+      opts.on('-r', '--require SCRIPT', String,
+              'Require the library, before executing your script') do |name|
+        if name == 'debug'
+          stderr.puts "ruby-debug is not compatible with Ruby's 'debug' library. This option is ignored."
+        else
+          require name
+        end
+      end
+      opts.on('-s', '--server',
+              'Set up for out-of-process debugging') do
         if options[:client]
-          stderr.puts "--client option previously given. --server option ignored."
+          stderr.puts '--client option previously given. --server option ignored.'
         else
           options[:server] = true
         end
       end
-      opts.on('--[no-]highlight',
-              "Use [no] syntax highlight output") do |v|
-        options[:highlight] = ((v) ? :term : nil)
-      end
-      opts.on('--[no-]readline',
-              "Try [not] GNU Readline") do |v|
-        options[:readline] = v
+      opts.on('-x', '--trace', 'Turn on line tracing') do
+        options[:tracing] = true
       end
-      opts.on_tail("-?", "--help", "Show this message") do
+      opts.separator ''
+      opts.on_tail('-?', '--help', 'Show this message') do
         options[:help] = true
         stdout.puts opts
+        exit 
       end
-      opts.on_tail("-v", "--version", 
-                   "print the version") do
+      opts.on_tail('-v', '--version', 
+                   'print the version') do
         options[:version] = true
         stdout.puts show_version
       end

data/app/util.rb

@@ -11,14 +11,64 @@ class Trepan
         str
       end
     end
+
+    # name is String and list is an Array of String.
+    # If name is a unique leading prefix of one of the entries of list,
+    # then return that. Otherwise return name.
+    def uniq_abbrev(list, name)
+      candidates = list.select do |try_name| 
+        try_name.start_with?(name)
+      end
+      candidates.size == 1 ? candidates.first : name
+    end
+
+    # extract the "expression" part of a line of source code.
+    # 
+    def extract_expression(text)
+      if text =~ /^\s*(?:if|elsif|unless)\s+/
+        text.gsub!(/^\s*(?:if|elsif|unless)\s+/,'') 
+        text.gsub!(/\s+then\s*$/, '')
+      elsif text =~ /^\s*(?:until|while)\s+/
+        text.gsub!(/^\s*(?:until|while)\s+/,'') 
+        text.gsub!(/\s+do\s*$/, '')
+      elsif text =~ /^\s*return\s+/
+        # EXPRESION in: return EXPRESSION
+        text.gsub!(/^\s*return\s+/,'')
+      elsif text =~ /^\s*case\s+/
+        # EXPRESSION in: case EXPESSION
+        text.gsub!(/^\s*case\s*/,'')
+      elsif text =~ /^\s*def\s*.*\(.+\)/
+        text.gsub!(/^\s*def\s*.*\((.*)\)/,'[\1]')
+      elsif text =~ /^\s*[A-Za-z_][A-Za-z0-9_\[\]]*\s*=[^=>]/
+        # RHS of an assignment statement.
+        text.gsub!(/^\s*[A-Za-z_][A-Za-z0-9_\[\]]*\s*=/,'')
+      end
+      return text
+    end
   end
 end
 
 if __FILE__ == $0
   include Trepan::Util
+  # save repr
   string = 'The time has come to talk of many things.'
   puts safe_repr(string, 50)
   puts safe_repr(string, 17)
   puts safe_repr(string.inspect, 17)
   puts safe_repr(string.inspect, 17, '')
+  # ------------------------------------
+  # extract_expression
+  ['if condition("if")', 
+   'until until_termination',
+   'return return_value',
+    'nothing_to_be.done'
+  ].each do |stmt|
+    puts extract_expression stmt
+  end
+
+  list = %w(disassemble disable distance up)
+  p list
+  %w(dis disa u upper foo).each do |name|
+    puts "uniq_abbrev of #{name} is #{uniq_abbrev(list, name)}"
+  end
 end

data/interface/base_intf.rb

@@ -59,6 +59,10 @@ class Trepan
     end
 
     def finalize(last_wishes=nil)
+      if @output && !@output.closed?
+        msg "%sThat's all, folks..." % 
+          (defined?(Trepan::PROGRAM) ? "#{Trepan::PROGRAM}: " : '')
+      end
       close
     end
 

data/interface/client.rb

@@ -45,6 +45,10 @@ class Trepan::ClientInterface < Trepan::Interface
       end
   end
 
+  def closed?
+    @inout.closed?
+  end
+
   def confirm(prompt, default)
     @user.confirm(prompt, default)
   end

data/interface/script.rb

@@ -27,7 +27,7 @@ class Trepan::ScriptInterface < Trepan::Interface
     @input           = opts[:input] || 
       Trepan::UserInput.open(script_name, :line_edit => false)
     @buffer_output   = []
-    unless opts[:verbose] or out
+    unless @opts[:verbose] or out
       out = Trepan::StringArrayOutput.open(@buffer_output)
     end
     super(@input, out, @opts)

data/interface/server.rb

@@ -51,6 +51,10 @@ class Trepan::ServerInterface < Trepan::Interface
     end
   end
   
+  def closed?
+    @inout.closed?
+  end
+
   # Called when a dangerous action is about to be done to make sure
   # it's okay. `prompt' is printed; user response is returned.
   # FIXME: make common routine for this and user.rb

data/interface/user.rb

@@ -37,6 +37,10 @@ class Trepan::UserInterface < Trepan::Interface
     at_exit { finalize }
   end
 
+  def closed?
+    @input.closed? && @output.closed?
+  end
+
   # Called when a dangerous action is about to be done, to make
   # sure it's okay. Expect a yes/no answer to `prompt' which is printed,
   # suffixed with a question mark and the default value.  The user
@@ -146,4 +150,5 @@ if __FILE__ == $0
       puts "EOF is now: %s" % intf.input.eof?.inspect
     end
   end
+  puts "User interface closed?: #{intf.closed?}"
 end

data/io/input.rb

@@ -37,7 +37,7 @@ class Trepan
           line = Readline.readline(prompt, true)
         else
           line = @input.gets
-          end
+        end
       rescue Interrupt
         return ''
       rescue EOFError
@@ -76,13 +76,14 @@ class Trepan
           rescue
           end
           @@readline_finalized = true
-        end
+       end
       end
     end
   end
 end
 
 def Trepan::GNU_readline?
+  @have_readline ||= nil
   begin
     return @have_readline unless @have_readline.nil?
     @have_readline = require 'readline'

data/io/null_output.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>
 
 # Nukes output. Used for example in sourcing where you don't want
 # to see output.
@@ -10,10 +10,16 @@ require_relative 'base_io'
 class Trepan
   class OutputNull < Trepan::OutputBase
     def initialize(out, opts={})
+      @closed = false
       super
     end
 
     def close
+      @closed = true
+    end
+
+    def closed?
+      !!@closed
     end
 
     def flush

data/processor/breakpoint.rb

@@ -1,7 +1,8 @@
-# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Copyright (C) 2010, 2011 Rocky Bernstein <rockyb@rubyforge.net>
+require_relative 'virtual'
 class Trepan
 
-  class CmdProcessor
+  class CmdProcessor < VirtualCmdProcessor
 
     attr_reader   :brkpts          # BreakpointManager. 
 

data/processor/command/base/subcmd.rb

@@ -201,7 +201,7 @@ module Trepanning
       dirname    = File.basename(File.dirname(File.expand_path(__file__)))
       name = File.basename(__file__, '.rb')
       klass.const_set('NAME', name)
-      prefix = klass.const_set('PREFIX', %W(#{dirname[0...-'_subcmd'.size]} #{name}))
+      prefix = klass.const_set(:PREFIX, %W(#{dirname[0...-'_subcmd'.size]} #{name}))
       klass.const_set('CMD', prefix.join(' '))
     end
   end

data/processor/command/base/submgr.rb

@@ -174,7 +174,10 @@ class Trepan::SubcommandMgr < Trepan::Command
     # Run that.
     subcmd = @subcmds.lookup(subcmd_prefix)
     if subcmd
-      subcmd.run(args)
+      if @proc.ok_for_running(subcmd, subcmd.class.const_get('CMD'),
+                              args.size-2)
+        subcmd.run(args)
+      end
     else
       undefined_subcmd(@name, subcmd_prefix)
     end

data/processor/command/base/subsubcmd.rb

@@ -99,9 +99,9 @@ module Trepanning
 
       short_dirname = dirname[0...-'_subcmd'.size]
       short_parent_dirname = parent_dirname[0...-'_subcmd'.size]
-      prefix = klass.const_set('PREFIX', %W(#{short_parent_dirname} 
+      prefix = klass.const_set(:PREFIX, %W(#{short_parent_dirname} 
                                             #{short_dirname} #{name}))
-      klass.const_set('CMD', prefix.join(' '))
+      klass.const_set(:CMD, prefix.join(' '))
     end
   end
 end

data/processor/command/base/subsubmgr.rb

@@ -38,7 +38,7 @@ class Trepan::SubSubcommandMgr < Trepan::Subcommand
     # we are the super class but want to set the subclass's constant.
     # defined? didn't seem to work here.
     c = self.class.constants
-    self.class.const_set('SHORT_HELP', 
+    self.class.const_set(:SHORT_HELP, 
                          self.class.const_get('HELP')) if
       c.member?(:HELP) and !c.member?(:SHORT_HELP)
     

data/processor/command/break.rb

@@ -33,7 +33,7 @@ See also condition, continue and "help location".
   end
 
   # This method runs the command
-  def run(args)
+  def run(args, temp=false)
     # FIXME: handle more conditions
     # a line number
     if args.size == 1
@@ -45,12 +45,16 @@ See also condition, continue and "help location".
       iseq, line_number, vm_offset, condition, negate = 
         @proc.breakpoint_position(@proc.cmd_argstr, true)
       return false unless iseq && vm_offset
-      bp = @proc.breakpoint_offset(vm_offset, iseq, condition, negate)
+      bp = @proc.breakpoint_offset(vm_offset, iseq, condition, negate, temp)
     end
     if bp
       bp.condition = condition
 
-      mess = "Breakpoint %d set at " % bp.id
+      if temp
+        mess = "Temporary breakpoint %d set at " % bp.id
+      else
+        mess = "Breakpoint %d set at " % bp.id
+      end
 
       line_loc = "line %s in %s" % 
         [bp.source_location.join(', '),

data/processor/command/complete.rb

@@ -29,6 +29,7 @@ if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
   %w(d b bt).each do |prefix|
+    cmd.proc.instance_variable_set('@cmd_argstr', prefix)
     cmd.run [cmd.name, prefix]
     puts '=' * 40
   end

data/processor/command/continue.rb

@@ -43,7 +43,7 @@ See also 'step', 'next', 'finish', 'nexti' commands and "help location".
       iseq, line_number, vm_offset, condition, negate = 
         @proc.breakpoint_position(@proc.cmd_argstr, false)
       return false unless iseq && vm_offset
-      bp = @proc.breakpoint_offset(vm_offset, iseq, condition, negate)
+      bp = @proc.breakpoint_offset(vm_offset, iseq, condition, negate, true)
       return unless bp
       @proc.continue
     end

data/processor/command/disassemble.rb

@@ -10,7 +10,7 @@ class Trepan::Command::DisassembleCommand < Trepan::Command
 
   unless defined?(HELP)
     NAME = File.basename(__FILE__, '.rb')
-    ALIASES       = %w(disas disassem) # Note we have disable
+    ALIASES       = %w(disasm) # Note we have disable
     CATEGORY      = 'data'
     HELP          = <<-HELP
 #{NAME} [thing] [full]

data/processor/command/edit.rb

@@ -8,38 +8,57 @@ class Trepan::Command::EditCommand < Trepan::Command
   $VERBOSE    = nil
   NAME        = File.basename(__FILE__, '.rb')
   HELP    = <<-HELP
-#{NAME} [LOCATION]
+#{NAME} [[FILE] [LINE]]
 
 With no argument, edits file containing most recent line listed.
+The value of the environment variable EDITOR is used for the
+editor to run. If no EDITOR environment variable is set /bin/ex
+is used. The editor should support line and file positioning via
+   editor-name +line file-name
+(Most editors do.)
 
-Editing targets can also be specified.
+Examples:
+#{NAME}            # Edit current location
+#{NAME} 7          # Edit current file at line 7
+#{NAME} test.rb    # Edit test.rb, line 1
+#{NAME} test.rb 10 # Edit test.rb  line 10
       HELP
 
   ALIASES       = %w(e)
   CATEGORY      = 'files'
   NEED_STACK    = false
-  SHORT_HELP    = 'Edit specified file or function'
+  SHORT_HELP    = 'Invoke an editor on some source code'
+  MAX_ARGS      = 2
   $VERBOSE      = old_verbose 
 
+  # FIXME: redo with locations and kparse.
   def run(args)
-    if args.size == 1
-
-      unless true # @state.context
-        errmsg "We are not in a state that has an associated file.\n"
-        return 
+    case args.size
+    when 1
+      file = @proc.frame.source_container[1]
+      line = @proc.frame.source_location[0]
+    when 2
+      line = Integer(args[1]) rescue nil
+      if line 
+        file = @proc.frame.source_container[1]
+      else 
+        file = args[1]
+        line = 1
       end
+    when 3
+      line, file =  args[2], args[1]
     else
-      text = @proc.cmd_argstr
+      errmsg "edit needs at most 2 args." 
     end
     editor = ENV['EDITOR'] || '/bin/ex'
-    file = @proc.frame.file
     if File.readable?(file)
-      edit_cmd = "#{editor} +#{@proc.frame.line} \"#{file}\""
+      file = File.basename(file) if settings[:basename]
+      edit_cmd = "#{editor} +#{line} \"#{file}\""
       msg "Running #{edit_cmd}..."
       system(edit_cmd)
       msg "Warning: return code was #{$?.exitstatus}" if $?.exitstatus != 0
     else
-      errmsg "File \"#{file}\" is not readable.\n"
+      errmsg "File \"#{file}\" is not readable."
     end
   end
 end
@@ -47,6 +66,8 @@ end
 if __FILE__ == $0
   require_relative '../mock'
   dbgr, cmd = MockDebugger::setup
-  dbgr, cmd = MockDebugger::setup
-  cmd.run [cmd.name] if ARGV.size > 0
+  ENV['EDITOR'] = 'echo FAKE-EDITOR'
+  cmd.run [cmd.name] 
+  cmd.run [cmd.name, '7'] 
+  cmd.run [cmd.name, __FILE__, '10'] 
 end