trepanning 0.0.4

data/processor/location.rb

@@ -0,0 +1,126 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+require 'linecache'
+require_relative 'msg'
+require_relative '../app/frame'
+class Trepan
+  class CmdProcessor
+    attr_accessor :reload_on_change
+    include Frame
+
+    def location_initialize
+      @reload_on_change = nil
+    end
+
+    def resolve_file_with_dir(path_suffix)
+      settings[:directory].split(/:/).each do |dir|
+        dir = 
+          if '$cwd' == dir
+            Dir.pwd
+          elsif '$cdir' == dir
+            @dbgr.initial_dir
+          else
+            dir
+          end
+        next unless dir && File.directory?(dir)
+        try_file = File.join(dir, path_suffix)
+        return try_file if File.readable?(try_file)
+      end
+      nil
+    end
+
+    # Get line +line_number+ from file named +filename+. Return "\n"
+    # there was a problem. Leading blanks are stripped off.
+    def line_at(filename, line_number) # :nodoc:
+      line = LineCache::getline(filename, line_number, @reload_on_change)
+      unless line
+        # Try using search directories (set with command "directory")
+        if filename[0..0] != File::SEPARATOR
+          try_filename = resolve_file_with_dir(filename) 
+          if try_filename && 
+              line = LineCache::getline(try_filename, line_number, 
+                                        @reload_on_change)
+            LineCache::remap_file(filename, try_filename)
+          end
+        end
+      end
+      return "\n" unless line
+      return line.lstrip.chomp
+    end
+
+    def loc_and_text(loc, frame, line_no, source_container)
+      if source_container[0] != 'file'
+        via = loc
+        while source_container[0] != 'file' && frame.prev do
+          frame            = frame.prev
+          source_container = frame_container(frame, false)
+        end
+        if source_container[0] == 'file'
+          line_no  = frame.source_location[0]
+          filename  = source_container[1]
+          loc      += " via #{canonic_file(filename)}:#{line_no}"
+          text      = line_at(filename, line_no)
+        end
+      else
+        container = source_container[1]
+        map_file, map_line = LineCache::map_file_line(container, line_no)
+        if [container, line_no] != [map_file, map_line]
+          loc += " remapped #{canonic_file(map_file)}:#{map_line}"
+        end
+        
+        text  = line_at(container, line_no)
+      end
+      [loc, line_no, text]
+    end
+
+    def print_location
+      if %w(c-call call).member?(@event)
+        # FIXME: Fix Ruby so we don't need this workaround? 
+        # See also where.rb
+        opts = {}
+        opts[:class] = @core.hook_arg if 
+          'CFUNC' == @frame.type && @core.hook_arg && 0 == @frame_index 
+        msg format_stack_call(@frame, opts) 
+      elsif 'raise' == @event
+        msg @core.hook_arg.inspect if @core.hook_arg # Exception object
+      end
+
+      text      = nil
+      source_container = frame_container(@frame, false)
+      ev        = if @event.nil? || 0 != @frame_index
+                    '  ' 
+                  else
+                    (EVENT2ICON[@event] || @event)
+                  end
+      @line_no  = frame_line
+
+      loc = source_location_info(source_container, @line_no, @frame)
+      loc, @line_no, text = loc_and_text(loc, @frame, @line_no, 
+                                         source_container)
+      msg "#{ev} (#{loc})"
+
+      if %w(return c-return).member?(@event)
+        retval = Trepan::Frame.value_returned(@frame, @event)
+        msg 'R=> %s' % retval.inspect 
+      end
+      
+      if text && !text.strip.empty?
+        msg text
+        @line_no -= 1
+      end
+    end
+
+    def source_location_info(source_container, line_no, frame)
+      filename  = source_container[1]
+      canonic_filename = 
+        if (0 == filename.index('(eval')) && frame.prev &&
+            (eval_str = Trepan::Frame.eval_string(frame.prev))
+          'eval ' + safe_repr(eval_str, 15)
+        else
+          canonic_file(filename)
+        end
+      loc = "#{canonic_filename}:#{line_no}"
+      return loc
+    end # source_location_info
+
+  end
+end

data/processor/main.rb

@@ -0,0 +1,364 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# The main "driver" class for a command processor. Other parts of the 
+# command class and debugger command objects are pulled in from here.
+
+require 'linecache'
+require 'set'
+require 'pathname'  # For cleanpath
+
+%w(default breakpoint display eventbuf eval load_cmds location frame hook msg 
+   running validate).each do
+  |mod_str|
+  require_relative mod_str
+end
+require_relative '../app/brkptmgr'
+
+class Trepan
+  class CmdProcessor
+
+    # SEE ALSO attr's in require_relative's of loop above.
+
+    attr_reader   :cmd_argstr      # Current command args, a String.
+                                   # This is current_command with the command
+                                   # name removed from the beginning.
+    attr_reader   :cmd_name        # command name before alias or macro resolution
+    attr_reader   :core            # Trepan core object
+    attr_reader   :current_command # Current command getting run, a String.
+    attr_reader   :dbgr            # Trepan instance (via
+                                   # Trepan::Core instance)
+    attr_accessor :debug_nest      # Number of nested debugs. Used in showing
+                                   # prompt.
+    attr_accessor :different_pos   # Same type as settings[:different] 
+                                   # this is the temporary value for the
+                                   # next stop while settings is the default
+                                   # value to use.
+    attr_accessor :event           # Stop event. Same as @core.event
+    attr_accessor :leave_cmd_loop  # Commands set this to signal to leave
+                                   # the command loop (which often continues to 
+                                   # run the debugged program). 
+    attr_accessor :line_no         # Last line shown in "list" command
+    attr_accessor :next_level      # Fixnum. frame.stack_size has to
+                                   # be <= than this.  If next'ing,
+                                   # this will be > 0.
+    attr_accessor :next_thread     # Thread. If non-nil then in
+                                   # stepping the thread has to be
+                                   # this thread.
+    attr_accessor :pass_exception  # Pass an exception back 
+    attr_accessor :prompt          # String print before requesting input
+    attr_reader   :settings        # Hash[:symbol] of command
+                                   # processor settings
+
+    # The following are used in to force stopping at a different line
+    # number. FIXME: could generalize to a position object.
+    attr_accessor :last_pos       # Last position. 6-Tuple: of
+                                  # [location, container, stack_size, 
+                                  #  current_thread, pc_offset]
+
+
+    unless defined?(EVENT2ICON)
+      # We use event icons in printing locations.
+      EVENT2ICON = {
+        'brkpt'          => 'xx',
+        'c-call'         => 'C>',
+        'c-return'       => '<C',
+        'call'           => '->',
+        'class'          => '::',
+        'coverage'       => '[]',
+        'debugger-call'  => ':o',
+        'end'            => '-|',
+        'line'           => '--',
+        'raise'          => '!!',
+        'return'         => '<-',
+        'switch'         => 'sw',
+        'trace-var'      => '$V',
+        'unknown'        => '?!',
+        'vm'             => 'VM',
+        'vm-insn'        => '..',
+      } 
+      # These events are important enough event that we always want to
+      # stop on them.
+      UNMASKABLE_EVENTS = Set.new(['end', 'raise', 'unknown'])
+    end
+
+    def initialize(core, settings={})
+      @core            = core
+      @debug_nest      = 1
+      @dbgr            = core.dbgr
+      @hidelevels      = {}
+      @last_command    = nil
+      @last_pos        = [nil, nil, nil, nil, nil, nil]
+      @next_level      = 32000
+      @next_thread     = nil
+
+      start_cmds       = settings.delete(:start_cmds)
+      start_file       = settings.delete(:start_file)
+
+      @settings        = settings.merge(DEFAULT_SETTINGS)
+      @different_pos   = @settings[:different]
+
+      # FIXME: Rework using a general "set substitute file" command and
+      # a global default profile which gets read.
+      file = File.expand_path(File.join(File.dirname(__FILE__), 
+                                        %w(.. data prelude.rb)))
+      LineCache::cache(file)
+      LineCache::remap_file('<internal:prelude>', file)
+      file = File.expand_path(File.join(File.dirname(__FILE__), 
+                                        %w(.. data custom_require.rb)))
+      LineCache::cache(file)
+      LineCache::remap_file('<internal:lib/rubygems/custom_require>', 
+                            file)
+
+      # Start with empty thread and frame info.
+      frame_teardown 
+
+      # Run initialization routines for each of the "submodule"s.
+      # load_cmds has to come first.
+      %w(load_cmds breakpoint display eventbuf frame running validate
+         ).each do |submod|
+        self.send("#{submod}_initialize")
+      end
+      hook_initialize(commands)
+
+      # FIXME: run start file and start commands.
+    end
+
+    def canonic_container(container)
+      [container[0], canonic_file(container[1])]
+    end
+
+    def canonic_file(filename)
+      # For now we want resolved filenames 
+      @settings[:basename] ? File.basename(filename) : 
+        # Cache this?
+        Pathname.new(filename).cleanpath.to_s
+    end
+
+    def compute_prompt
+      thread_str = 
+        if 1 == Thread.list.size
+          ''
+        elsif Thread.current == Thread.main
+          '@main'
+        else
+          "@#{Thread.current.object_id}"
+        end
+      "%s#{settings[:prompt]}%s%s: " % 
+        ['(' * @debug_nest, thread_str, ')' * @debug_nest]
+      
+    end
+
+    # Check that we meed the criteria that cmd specifies it needs
+    def ok_for_running(cmd, name, nargs)
+      # TODO check execution_set against execution status.
+      # Check we have frame is not null
+      min_args = cmd.class.const_get(:MIN_ARGS)
+      if nargs < min_args
+        errmsg(("Command '%s' needs at least %d argument(s); " + 
+                "got %d.") % [name, min_args, nargs])
+        return false
+      end
+      max_args = cmd.class.const_get(:MAX_ARGS)
+      if max_args and nargs > max_args
+        errmsg(("Command '%s' needs at most %d argument(s); " + 
+                "got %d.") % [name, max_args, nargs])
+        return false
+      end
+      # if cmd.class.const_get(:NEED_RUNNING) && !...
+      #   errmsg "Command '%s' requires a running program." % name
+      #   return false
+      # end
+
+      if cmd.class.const_get(:NEED_STACK) && !@frame
+        errmsg "Command '%s' requires a running stack frame." % name
+        return false
+      end
+
+      return true
+    end
+
+    # Run one debugger command. True is returned if we want to quit.
+    def process_command_and_quit?()
+      intf = @dbgr.intf
+      return true if intf[-1].input.eof? && intf.size == 1
+      while !intf[-1].input.eof? || intf.size > 1
+        begin
+          @current_command = read_command().strip
+          if @current_command.empty? 
+            if @last_command && intf[-1].interactive?
+              @current_command = @last_command 
+            else
+              next
+            end
+          end
+          next if @current_command[0..0] == '#' # Skip comment lines
+          break
+        rescue IOError, Errno::EPIPE
+          if @dbgr.intf.size > 1
+            @dbgr.intf.pop 
+            @last_command = nil
+            print_location
+          else
+            msg "EOF - Leaving"
+            ## FIXME: think of something better.
+            quit('quit!')
+            return true
+          end
+        end
+      end
+      run_command(@current_command)
+    end
+
+    # This is the main entry point.
+    def process_commands(frame)
+
+      frame_setup(frame)
+      @event = @core.event
+
+      @unconditional_prehooks.run
+      if breakpoint?
+        @last_pos = [@frame.source_container, frame_line,
+                     @stack_size, @current_thread, @event, 
+                     @frame.pc_offset]
+      else
+        return if stepping_skip? || @stack_size <= @hide_level
+      end
+
+      @prompt = compute_prompt
+
+      @leave_cmd_loop = false
+      print_location unless @settings[:traceprint]
+      if 'trace-var' == @event 
+        msg "Note: we are stopped *after* the above location."
+      end
+
+      @eventbuf.add_mark if @settings[:tracebuffer]
+
+      @cmdloop_prehooks.run
+      while not @leave_cmd_loop do
+        begin
+          break if process_command_and_quit?()
+        rescue SystemExit
+          @dbgr.stop
+          raise
+        rescue Exception => exc
+          msg("Internal debugger error: #{exc.inspect}")
+          exception_dump(exc, @settings[:debugexcept], $!.backtrace)
+        end
+      end
+      @cmdloop_posthooks.run
+    end
+
+    # Run current_command, a String. @last_command is set after the
+    # command is run if it is a command.
+    def run_command(current_command)
+      eval_command = 
+        if current_command[0..0] == '!'
+          current_command[0] = ''
+        else
+          false
+        end
+
+      unless eval_command
+        # Expand macros. FIXME: put in a procedure
+        args = current_command.split
+        while true do
+          macro_cmd_name = args[0]
+          return false if args.size == 0
+          break unless @macros.member?(macro_cmd_name)
+          current_command = @macros[macro_cmd_name].call(*args[1..-1])
+          msg current_command if settings[:debugmacro]
+          if current_command.is_a?(Array) && 
+              current_command.any {|val| !val.is_a?(String)}
+            args = current_command
+          elsif current_command.is_a?(String)
+            args = current_command.split
+          else
+            errmsg("macro #{macro_cmd_name} should return an Array " +
+                   "of Strings or a String. Got #{current_command.inspect}")
+            return false
+          end
+        end
+
+        @cmd_name = args[0]
+        run_cmd_name = 
+          if @aliases.member?(@cmd_name)
+            @aliases[@cmd_name] 
+          else
+            @cmd_name
+          end
+            
+        if @commands.member?(run_cmd_name)
+          cmd = @commands[run_cmd_name]
+          if ok_for_running(cmd, run_cmd_name, args.size-1)
+            @cmd_argstr = current_command[@cmd_name.size..-1].lstrip
+            cmd.run(args) 
+            @last_command = current_command
+          end
+          return false
+        end
+      end
+
+      # Eval anything that's not a command or has been
+      # requested to be eval'd
+      if settings[:autoeval] || eval_command
+        ## eval_code(current_command, @settings[:maxstring])
+        msg 'D=> ' + debug_eval(current_command).inspect
+      else
+        undefined_command(cmd_name)
+      end
+      return false
+    end
+
+    # Error message when a command doesn't exist
+    def undefined_command(cmd_name)
+      errmsg('Undefined command: "%s". Try "help".' % cmd_name)
+    end
+
+    # FIXME: Allow access to both Trepan::CmdProcessor and Trepan
+    # for index [] and []=.
+    # If there is a Trepan::CmdProcessor setting that would take precidence.
+    # def settings
+    #   @settings.merge(@dbgr.settings) # wrong because this doesn't allow []=
+    # end
+  end
+end
+
+if __FILE__ == $0
+  $0 = 'foo' # So we don't get here again
+  require_relative '../lib/trepanning'
+  dbg =  Trepan.new(:nx => true)
+  dbg.core.processor.msg('I am main')
+  cmdproc = dbg.core.processor
+  cmdproc.errmsg('Whoa!')
+  cmds = cmdproc.commands
+  p cmdproc.aliases
+  cmd_name, cmd_obj = cmds.first
+  puts cmd_obj.class.const_get(:HELP)
+  puts cmd_obj.class.const_get(:SHORT_HELP)
+
+  puts cmdproc.compute_prompt
+  Thread.new{ puts cmdproc.compute_prompt }.join
+
+  th = Thread.new{ Thread.pass; x = 1 }
+  puts cmdproc.compute_prompt
+  th.join
+  cmdproc.debug_nest += 1
+  puts cmdproc.compute_prompt
+
+
+  if ARGV.size > 0
+    dbg.core.processor.msg('Enter "q" to quit')
+    dbg.proc_process_commands
+  else
+    $input = []
+    class << dbg.core.processor
+      def read_command
+        $input.shift
+      end
+    end
+    $input = ['1+2']
+    dbg.core.processor.process_command_and_quit?
+    $input = ['!s = 5']  # ! means eval line 
+    dbg.core.processor.process_command_and_quit?
+  end
+end

data/processor/mock.rb

@@ -0,0 +1,100 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# Mock setup for commands.
+require_relative 'main'
+require_relative '../app/core'
+require_relative '../app/default'
+require_relative '../interface/user'  # user interface (includes I/O)
+
+SCRIPT_ISEQS__ = {} unless 
+  defined?(SCRIPT_ISEQS__) && SCRIPT_ISEQS__.is_a?(Hash)
+ISEQS__        = {} unless 
+  defined?(ISEQS__) && ISEQS__.is_a?(Hash)
+
+module MockDebugger
+  class MockDebugger
+    attr_accessor :trace_filter # Procs/Methods we ignore.
+
+    attr_accessor :core         # access to Debugger::Core instance
+    attr_accessor :intf         # The way the outside world interfaces with us.
+    attr_reader   :initial_dir  # String. Current directory when program
+                                # started. Used in restart program.
+    attr_accessor :restart_argv # How to restart us, empty or nil. 
+                                # Note restart[0] is typically $0.
+    attr_reader   :settings     # Hash[:symbol] of things you can configure
+
+    def initialize(settings={})
+      @before_cmdloop_hooks = []
+      @settings             = Trepanning::DEFAULT_SETTINGS.merge(settings)
+      @intf                 = [Trepan::UserInterface.new]
+      @core                 = Trepan::Core.new(self)
+      @trace_filter         = []
+
+      # Don't allow user commands in mocks.
+      @core.processor.settings[:user_cmd_dir] = nil 
+
+    end
+
+  end
+
+  # Common Mock debugger setup 
+  def setup(name, show_constants=true)
+    if ARGV.size > 0 && ARGV[0] == 'debug'
+      require_relative '../lib/trepanning'
+      dbgr = Trepan.new
+      dbgr.debugger
+    else
+      dbgr = MockDebugger.new
+    end
+
+    cmds = dbgr.core.processor.commands
+    cmd  = cmds[name]
+    cmd.proc.frame_setup(RubyVM::ThreadFrame::current.prev)
+    show_special_class_constants(cmd) if show_constants
+
+    def cmd.msg(message)
+      puts message
+    end
+    def cmd.msg_nocr(message)
+      print message
+    end
+    def cmd.errmsg(message)
+      puts "Error: #{message}"
+    end
+    def cmd.confirm(prompt, default)
+      true
+    end
+
+    return dbgr, cmd
+  end
+  module_function :setup
+
+  def show_special_class_constants(cmd)
+    puts 'ALIASES: %s' % [cmd.class.const_get('ALIASES').inspect] if
+      cmd.class.constants.member?(:ALIASES)
+    %w(CATEGORY HELP MIN_ARGS MAX_ARGS 
+       NAME NEED_STACK SHORT_HELP).each do |name|
+      puts '%s: %s' % [name, cmd.class.const_get(name).inspect]
+    end
+    puts '- - -'
+  end
+  module_function :show_special_class_constants
+
+end
+
+# To get Trepan::CmdProcessor defined and with the 
+# with the correct initialize parameters.
+class Trepan
+  class << CmdProcessor
+    def initialize(core, settings={})
+      @core            = core
+      @settings        = settings
+    end
+  end
+end
+
+if __FILE__ == $0
+  dbgr = MockDebugger::MockDebugger.new
+  p dbgr.settings
+  puts '=' * 10
+  p dbgr.core.processor.settings
+end

data/processor/msg.rb

@@ -0,0 +1,26 @@
+# Copyright (C) 2010 Rocky Bernstein <rockyb@rubyforge.net>
+# I/O related command processor methods
+require_relative '../app/util'
+class Trepan
+  class CmdProcessor
+    def errmsg(message)
+      @dbgr.intf[-1].errmsg(safe_rep(message))
+    end
+
+    def msg(message)
+      @dbgr.intf[-1].msg(safe_rep(message))
+    end
+
+    def msg_nocr(message)
+      @dbgr.intf[-1].msg_nocr(safe_rep(message))
+    end
+
+    def read_command()
+      @dbgr.intf[-1].read_command(@prompt)
+    end
+
+    def safe_rep(str)
+      Trepan::Util::safe_repr(str, @settings[:maxstring])
+    end
+  end
+end