byebug 0.0.1 → 1.0.0

data/lib/byebug/commands/show.rb

@@ -1,6 +1,8 @@
 module Byebug
+
   # Mix-in module to showing settings
-  module ShowFunctions # :nodoc:
+  module ShowFunctions
+
     def show_setting(setting_name)
       case setting_name
       when /^annotate$/
@@ -73,7 +75,7 @@ module Byebug
         return s
       when /^byebugtesting$/
         on_off = Command.settings[:byebugtesting]
-        return "Currently testing the byebug is #{show_onoff(on_off)}."
+        return "Currently testing byebug is #{show_onoff(on_off)}."
       when /^forcestep$/
         on_off = self.class.settings[:force_stepping]
         return "force-stepping is #{show_onoff(on_off)}."
@@ -116,7 +118,7 @@ module Byebug
         end
         return s.join("\n")
       when /^linetrace$/
-        on_off = Command.settings[:tracing]
+        on_off = Byebug.tracing
         return "line tracing is #{show_onoff(on_off)}."
       when /^linetrace\+$/
         on_off = Command.settings[:tracing_plus]
@@ -230,7 +232,7 @@ show history size -- Show the size of the command history"],
           end
         end
         s = "
-          Generic command for showing things about the byebug.
+          Generic command for showing things about byebug.
 
           --
           List of show subcommands:

data/lib/byebug/commands/stepping.rb

@@ -1,7 +1,7 @@
 module Byebug
 
   # Mix-in module to assist in command parsing.
-  module SteppingFunctions # :nodoc:
+  module SteppingFunctions
     def parse_stepping_args(command_name, match)
       if match[1].nil?
         force = Command.settings[:force_stepping]
@@ -62,7 +62,7 @@ module Byebug
     def execute
       steps, force = parse_stepping_args("Step", @match)
       return unless steps
-      @state.context.step(steps, force)
+      @state.context.step steps, force
       @state.proceed
     end
 

data/lib/byebug/commands/threads.rb

@@ -12,7 +12,7 @@ module Byebug
       end
       print "\n"
     end
-    
+
     def parse_thread_num(subcmd, arg)
       if '' == arg
         errmsg "'%s' needs a thread number\n" % subcmd
@@ -27,13 +27,13 @@ module Byebug
     def parse_thread_num_for_cmd(subcmd, arg)
       c = parse_thread_num(subcmd, arg)
       return nil unless c
-      case 
+      case
       when nil == c
         errmsg "No such thread.\n"
       when @state.context == c
         errmsg "It's the current thread.\n"
       when c.ignored?
-        errmsg "Can't #{subcmd} to the byebug thread #{arg}.\n"
+        errmsg "Can't #{subcmd} to byebug's thread #{arg}.\n"
       else # Everything is okay
         return c
       end
@@ -71,14 +71,14 @@ module Byebug
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
     self.need_context         = true
-    
+
     def regexp
       /^\s*th(?:read)?\s+stop\s*(\S*)\s*$/
     end
 
     def execute
       c = parse_thread_num_for_cmd("thread stop", @match[1])
-      return unless c 
+      return unless c
       c.suspend
       display_context(c)
     end
@@ -100,14 +100,14 @@ module Byebug
     self.allow_in_post_mortem = false
     self.allow_in_control = true
     self.need_context = true
-    
+
     def regexp
       /^\s*th(?:read)?\s+resume\s*(\S*)\s*$/
     end
 
     def execute
       c = parse_thread_num_for_cmd("thread resume", @match[1])
-      return unless c 
+      return unless c
       if !c.thread.stop?
         print "Already running."
         return
@@ -136,14 +136,14 @@ module Byebug
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
     self.need_context         = true
-    
+
     def regexp
       /^\s*th(?:read)?\s*(?:sw(?:itch)?)?\s+(\S+)\s*$/
     end
 
     def execute
       c = parse_thread_num_for_cmd("thread switch", @match[1])
-      return unless c 
+      return unless c
       display_context(c)
       c.stop_next = 1
       c.thread.run
@@ -165,7 +165,7 @@ module Byebug
 
   class ThreadCurrentCommand < Command # :nodoc:
     self.need_context = true
-    
+
     def regexp
       /^\s*th(?:read)?\s*(?:cur(?:rent)?)?\s*$/
     end

data/lib/byebug/commands/trace.rb

@@ -1,22 +1,22 @@
 module Byebug
   class TraceCommand < Command # :nodoc:
     def regexp
-      /^\s* tr(?:ace)? (?: \s+ (\S+))         # on |off | var(iable)
-                       (?: \s+ (\S+))?        # (all | variable-name)?
-                       (?: \s+ (\S+))? \s*    # (stop | nostop)?
+      /^\s* tr(?:ace)? (?: \s+ (\S+))      # on | off | var(iable)
+                       (?: \s+ (\S+))?     # (all | variable-name)?
+                       (?: \s+ (\S+))? \s* # (stop | nostop)?
        $/ix
     end
 
     def execute
       if @match[1] =~ /on|off/
         onoff = 'on' == @match[1]
-        if @match[2]
+        #if @match[2]
           Byebug.tracing = onoff
-          print "Tracing %s all threads.\n" % (onoff ? 'on' : 'off')
-        else
-          Byebug.current_context.tracing = onoff
-          print "Tracing %s on current thread.\n"  % (onoff ? 'on' : 'off')
-        end
+          print "Tracing is #{onoff ? 'on' : 'off'}"
+        #else
+        #  Byebug.current_context.tracing = onoff
+        #  print "Tracing %s on current thread.\n"  % (onoff ? 'on' : 'off')
+        #end
       elsif @match[1] =~ /var(?:iable)?/
         varname=@match[2]
         if debug_eval("defined?(#{varname})")
@@ -25,11 +25,10 @@ module Byebug
           else
             dbg_cmd = (@match[3] && (@match[3] !~ /nostop/)) ? 'byebug' : ''
           end
-          eval("
-           trace_var(:#{varname}) do |val|
-              print \"traced variable #{varname} has value \#{val}\n\"
-              #{dbg_cmd}
-           end")
+          eval("trace_var(:#{varname}) do |val|
+                  print \"traced variable #{varname} has value \#{val}\n\"
+                  #{dbg_cmd}
+                end")
         else
           errmsg "#{varname} is not a global variable.\n"
         end

data/lib/byebug/commands/variables.rb

@@ -1,10 +1,12 @@
 module Byebug
-  module VarFunctions # :nodoc:
+
+  module VarFunctions
     def var_list(ary, b = get_binding)
       ary.sort!
       for v in ary
         begin
-          s = debug_eval(v.to_s, b).inspect
+          s = debug_eval(v.to_s, b).inspect unless
+            v == :$KCODE || v == :$-K || v == :$=
         rescue
           begin
             s = debug_eval(v.to_s, b).to_s
@@ -24,7 +26,7 @@ module Byebug
     end
   end
 
-  # Implements the byebug 'var class' command.
+  # Implements byebug's 'var class' command
   class VarClassVarCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+cl(?:ass)?/
@@ -33,7 +35,7 @@ module Byebug
     def execute
       unless @state.context
         errmsg "can't get class variables here.\n"
-        return 
+        return
       end
       var_class_self
     end
@@ -51,7 +53,7 @@ module Byebug
     end
   end
 
-  class VarConstantCommand < Command # :nodoc:
+  class VarConstantCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+co(?:nst(?:ant)?)?\s+/
     end
@@ -84,7 +86,7 @@ module Byebug
     end
   end
 
-  class VarGlobalCommand < Command # :nodoc:
+  class VarGlobalCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+g(?:lobal)?\s*$/
     end
@@ -106,7 +108,7 @@ module Byebug
     end
   end
 
-  class VarInstanceCommand < Command # :nodoc:
+  class VarInstanceCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+ins(?:tance)?\s*/
     end
@@ -129,7 +131,7 @@ module Byebug
     end
   end
 
-  # Implements the byebug 'var local' command.
+  # Implements byebug's 'var local' command
   class VarLocalCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+l(?:ocal)?\s*$/
@@ -137,7 +139,7 @@ module Byebug
 
     def execute
       locals = @state.context.frame_locals(@state.frame_pos)
-      _self = @state.context.frame_self(@state.frame_pos) 
+      _self = @state.context.frame_self(@state.frame_pos)
       locals.keys.sort.each do |name|
         print "  %s => %p\n", name, locals[name]
       end
@@ -155,8 +157,7 @@ module Byebug
       end
     end
   end
-  
-    # Implements the byebug 'var inherit' command.
+
   begin
     require 'classtree'
     have_classtree = true
@@ -164,6 +165,7 @@ module Byebug
     have_classtree = false
   end
 
+  # Implements byebug's 'var inherit' command
   class VarInheritCommand < Command
     def regexp
       /^\s*v(?:ar)?\s+ct\s*/
@@ -172,7 +174,7 @@ module Byebug
     def execute
       unless @state.context
         errmsg "can't get object inheritance.\n"
-        return 
+        return
       end
       puts @match.post_match
       obj = debug_eval("#{@match.post_match}.classtree")

data/lib/byebug/context.rb

@@ -8,23 +8,10 @@ module Byebug
   end
 
   class Context
-
-    def frame_locals(frame_no=0)
-      result = {}
-      binding = frame_binding(frame_no)
-      locals = eval("local_variables", binding)
-      locals.each {|local| result[local.to_s] = eval(local.to_s, binding)}
-      result
-    end
-
     def frame_class(frame_no=0)
       frame_self(frame_no).class
     end
 
-    def frame_args_info(frame_no=0)
-      nil
-    end
-
     def interrupt
       self.stop_next = 1
     end
@@ -42,8 +29,8 @@ module Byebug
     end
 
     def at_tracing(file, line)
-      @tracing_started = File.identical?(file, Byebug::PROG_SCRIPT)
-      handler.at_tracing(self, file, line) if @tracing_started
+      handler.at_tracing(self, file, line) if
+        File.identical?(file, Byebug::PROG_SCRIPT)
     end
 
     def at_line(file, line)

data/lib/byebug/interface.rb

@@ -64,6 +64,11 @@ module Byebug
       readline(prompt, false)
     end
 
+    # Callers of this routine should make sure to use comma to separate format
+    # argments rather than %. Otherwise it seems that if the string you want to
+    # print has format specifier, which could happen if you are trying to show
+    # say a source-code line with "puts" or "print" in it, this print routine
+    # will give an error saying it is looking for more arguments.
     def print(*args)
       STDOUT.printf(*args)
     end

data/lib/byebug/processor.rb

@@ -1,12 +1,16 @@
+require 'forwardable'
 require_relative 'interface'
 require_relative 'command'
 
 module Byebug
 
   # Should this be a mixin?
-  class Processor # :nodoc
+  class Processor
     attr_accessor :interface
 
+    extend Forwardable
+    def_delegators :@interface, :errmsg, :print
+
     # Format msg with gdb-style annotation header
     def afmt(msg, newline="\n")
       "\032\032#{msg}#{newline}"
@@ -16,24 +20,10 @@ module Byebug
       print afmt(msg) if Byebug.annotate.to_i > 2
     end
 
-    # FIXME: use delegate?
-    def errmsg(*args)
-      @interface.errmsg(*args)
-    end
-
-    # Callers of this routine should make sure to use comma to separate format
-    # argments rather than %. Otherwise it seems that if the string you want to
-    # print has format specifier, which could happen if you are trying to show
-    # say a source-code line with "puts" or "print" in it, this print routine
-    # will give an error saying it is looking for more arguments.
-    def print(*args)
-      @interface.print(*args)
-    end
-
   end
 
-  class CommandProcessor < Processor # :nodoc:
-    attr_reader   :display
+  class CommandProcessor < Processor
+    attr_reader :display
 
     # FIXME: get from Command regexp method.
     @@Show_breakpoints_postcmd = [
@@ -79,10 +69,12 @@ module Byebug
 
     require 'pathname'  # For cleanpath
 
+    ##
     # Regularize file name.
-    # This is also used as a common funnel place if basename is
-    # desired or if we are working remotely and want to change the
-    # basename. Or we are eliding filenames.
+    #
+    # This is also used as a common funnel place if basename is desired or if we
+    # are working remotely and want to change the basename. Or we are eliding
+    # filenames.
     def self.canonic_file(filename)
       # For now we want resolved filenames
       if Command.settings[:basename]
@@ -94,13 +86,13 @@ module Byebug
     end
 
     def self.print_location_and_text(file, line)
-      file_line = "%s:%s\n%s" % [canonic_file(file), line,
-                                 Byebug.line_at(file, line)]
+      file_line = "#{canonic_file(file)}:#{line}\n#{Byebug.line_at(file, line)}"
+
       # FIXME: use annotations routines
       if Byebug.annotate.to_i > 2
         file_line = "\032\032source #{file_line}"
-      elsif ENV['EMACS']
-        file_line = "\032\032#{file_line}"
+      #elsif ENV['EMACS']
+      #  file_line = "\032\032#{file_line}"
       end
       print file_line
     end
@@ -132,7 +124,7 @@ module Byebug
       if Byebug.annotate.to_i > 2
         print afmt("source #{file}:#{line}")
       end
-      print "Breakpoint %d at %s:%s\n", n, file, line
+      print "Stopped at breakpoint %d at %s:%s\n", n, file, line
     end
     protect :at_breakpoint
 
@@ -153,15 +145,16 @@ module Byebug
     protect :at_catchpoint
 
     def at_tracing(context, file, line)
-      return if defined?(Byebug::RDEBUG_FILE) &&
-        Byebug::RDEBUG_FILE == file # Don't trace ourself
-      @last_file = CommandProcessor.canonic_file(file)
+      # Don't trace ourselves
+      return if defined?(Byebug::RDEBUG_FILE) && Byebug::RDEBUG_FILE == file
+
+      #@last_file = CommandProcessor.canonic_file(file)
       file = CommandProcessor.canonic_file(file)
-      unless file == @last_file and @last_line == line and
-          Command.settings[:tracing_plus]
-        print "Tracing:%s:%s %s", file, line, Byebug.line_at(file, line)
+      unless file == @last_file and line == @last_line and
+             Command.settings[:tracing_plus]
         @last_file = file
         @last_line = line
+        print "Tracing: #{file}:#{line} #{Byebug.line_at(file, line)}"
       end
       always_run(context, file, line, 2)
     end
@@ -179,16 +172,23 @@ module Byebug
 
     private
 
-      # The prompt shown before reading a command.
+      ##
+      # Prompt shown before reading a command.
+      #
       def prompt(context)
-        p = '(rdb:%s) ' % (context.dead?  ? 'post-mortem' : context.thnum)
+        p = '(byebug:%s) ' % (context.dead?  ? 'post-mortem' : context.thnum)
         p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if Byebug.annotate.to_i > 2
         return p
       end
 
-      # Run these commands, for example display commands or possibly the list or
-      # irb in an "autolist" or "autoirb". We return a list of commands that are
-      # acceptable to run bound to the current state.
+      ##
+      # Run commands everytime.
+      #
+      # For example display commands or possibly the list or irb in an
+      # "autolist" or "autoirb".
+      #
+      # @return List of commands acceptable to run bound to the current state
+      #
       def always_run(context, file, line, run_level)
         event_cmds = Command.commands.select{|cmd| cmd.event }
 
@@ -217,10 +217,16 @@ module Byebug
         return state, commands
       end
 
-      # Handle byebug commands
+      ##
+      # Handle byebug commands.
+      #
       def process_commands(context, file, line)
         state, commands = always_run(context, file, line, 1)
-        $rdebug_state = state if Command.settings[:byebugtesting]
+        if Command.settings[:byebugtesting]
+          $byebug_state = state
+        else
+          $byebug_state = nil
+        end
         splitter = lambda do |str|
           str.split(/;/).inject([]) do |m, v|
             if m.empty?
@@ -262,10 +268,12 @@ module Byebug
         postloop(commands, context)
       end # process_commands
 
+      ##
+      # Executes a single byebug command
+      #
       def one_cmd(commands, context, input)
         if cmd = commands.find{ |c| c.match(input) }
           if context.dead? && cmd.class.need_context
-            p cmd
             print "Command is unavailable\n"
           else
             cmd.execute
@@ -341,13 +349,13 @@ module Byebug
 
       def display_annotations(commands, context)
         return if display.empty?
-#         have_display = display.find{|d| d[0]}
-#         return unless have_display and @byebug_displays_were_empty
-#         @byebug_displays_were_empty = have_display
+        #have_display = display.find{|d| d[0]}
+        #return unless have_display and @byebug_displays_were_empty
+        #@byebug_displays_were_empty = have_display
         annotation('display', commands, context, "display")
       end
 
-      class State # :nodoc:
+      class State
         attr_accessor :binding, :commands, :context, :display, :file, :frame_pos
         attr_accessor :interface, :line, :previous_line
 
@@ -359,18 +367,8 @@ module Byebug
           yield self
         end
 
-        # FIXME: use delegate?
-        def errmsg(*args)
-          @interface.errmsg(*args)
-        end
-
-        def print(*args)
-          @interface.print(*args)
-        end
-
-        def confirm(*args)
-          @interface.confirm(*args)
-        end
+        extend Forwardable
+        def_delegators :@interface, :errmsg, :print, :confirm
 
         def proceed?
           @proceed
@@ -383,7 +381,9 @@ module Byebug
 
   end # end class CommandProcessor
 
+
   class ControlCommandProcessor < Processor # :nodoc:
+
     def initialize(interface)
       super()
       @interface = interface
@@ -432,7 +432,7 @@ module Byebug
       return p
     end
 
-    class State # :nodoc:
+    class State
       attr_reader :commands, :interface
 
       def initialize(interface, commands)
@@ -443,13 +443,8 @@ module Byebug
       def proceed
       end
 
-      def errmsg(*args)
-        @interface.print(*args)
-      end
-
-      def print(*args)
-        @interface.print(*args)
-      end
+      extend Forwardable
+      def_delegators :@interface, :errmsg, :print
 
       def confirm(*args)
         'y'
@@ -463,6 +458,6 @@ module Byebug
         errmsg "No filename given.\n"
         throw :debug_error
       end
-    end # State
+    end
   end
 end