debugger 1.4.0 → 1.5.0

data/lib/ruby-debug/commands/threads.rb

@@ -1,21 +1,34 @@
 module Debugger
   module ThreadFunctions # :nodoc:
-    def display_context(c, show_top_frame=true)
-      c_flag = c.thread == Thread.current ? '+' : ' '
-      c_flag = '$' if c.suspended?
-      d_flag = c.ignored? ? '!' : ' '
-      print "%s%s", c_flag, d_flag
-      print "%d ", c.thnum
-      print "%s\t", c.thread.inspect
-      if c.stack_size > 0 and show_top_frame
-        print "%s:%d", c.frame_file(0), c.frame_line(0)
+    def display_context(context, should_show_top_frame = true)
+      print pr("thread.context", thread_arguments(context, should_show_top_frame))
+    end
+
+    def thread_arguments(context, should_show_top_frame = true)
+      is_current = context.thread == Thread.current
+      status_flag = if context.suspended?
+        "$"
+      else
+        is_current ? '+' : ' '
       end
-      print "\n"
+      debug_flag = context.ignored? ? '!' : ' '
+      file_line = if context.stack_size > 0 && should_show_top_frame
+        "#{context.frame_file(0)}:#{context.frame_line(0)}"
+      end
+      {
+        status_flag: status_flag,
+        debug_flag: debug_flag,
+        id: context.thnum,
+        thread: context.thread.inspect,
+        file_line: file_line,
+        status: context.thread.status,
+        current: is_current ? "yes" : "no"
+      }
     end
     
     def parse_thread_num(subcmd, arg)
       if '' == arg
-        errmsg "'%s' needs a thread number\n" % subcmd
+        errmsg pr("thread.errors.no_number", subcmd: subcmd)
         nil
       else
         thread_num = get_int(arg, "thread #{subcmd}", 1)
@@ -29,11 +42,11 @@ module Debugger
       return nil unless c
       case 
       when nil == c
-        errmsg "No such thread.\n"
+        errmsg pr("thread.errors.no_thread")
       when @state.context == c
-        errmsg "It's the current thread.\n"
+        errmsg pr("thread.errors.current_thread")
       when c.ignored?
-        errmsg "Can't #{subcmd} to the debugger thread #{arg}.\n"
+        errmsg pr("thread.errors.wrong_action", subcmd: subcmd, arg: arg)
       else # Everything is okay
         return c
       end
@@ -49,9 +62,7 @@ module Debugger
     end
 
     def execute
-      threads = Debugger.contexts.sort_by{|c| c.thnum}.each do |c|
-        display_context(c)
-      end
+      print prc("thread.context", Debugger.contexts.sort_by(&:thnum)) { |context, _| thread_arguments(context) }
     end
 
     class << self
@@ -109,7 +120,7 @@ module Debugger
       c = parse_thread_num_for_cmd("thread resume", @match[1])
       return unless c 
       if !c.thread.stop?
-        print "Already running."
+        errmsg pr("thread.errors.already_running")
         return
       end
       c.resume

data/lib/ruby-debug/commands/tmate.rb

@@ -9,7 +9,7 @@ module Debugger
         if @match[1]
           frm_n = @match[1].to_i
           if frm_n > @state.context.stack_size || frm_n == 0
-            print "Wrong frame number\n"
+            print pr("tmate.errors.wrong_frame")
             return
           end
           file, line = @state.context.frame_file(frm_n-1), @state.context.frame_line(frm_n-1)

data/lib/ruby-debug/commands/trace.rb

@@ -12,31 +12,30 @@ module Debugger
         onoff = 'on' == @match[1] 
         if @match[2]
           Debugger.tracing = onoff
-          print "Tracing %s all threads.\n" % (onoff ? 'on' : 'off')
+          print pr("trace.messages.all_threads", status: onoff ? 'on' : 'off')
         else
           Debugger.current_context.tracing = onoff
-          print "Tracing %s on current thread.\n"  % (onoff ? 'on' : 'off')
+          print pr("trace.messages.current_thread", status: onoff ? 'on' : 'off')
         end
       elsif @match[1] =~ /var(?:iable)?/
         varname=@match[2]
         if debug_eval("defined?(#{varname})")
           if @match[3] && @match[3] !~ /(:?no)?stop/
-            errmsg("expecting 'stop' or 'nostop'; got %s\n" % @match[3])
+            errmsg pr("trace.errors.wrong_var_subcommand", subcmd: @match[3])
           else
             dbg_cmd = if @match[3] && (@match[3] !~ /nostop/) 
                         'debugger' else '' end
           end
           eval("
            trace_var(:#{varname}) do |val|
-              print \"traced variable #{varname} has value \#{val}\n\"
+              print pr('trace.trace', name: '#{varname}', value: val)
               #{dbg_cmd}
            end")
         else
-          errmsg "#{varname} is not a global variable.\n"
+          errmsg pr("trace.errors.var_is_not_global", name: varname)
         end
       else 
-        errmsg("expecting 'on', 'off', 'var' or 'variable'; got: %s\n" %
-               @match[1])
+        errmsg pr("trace.errors.wrong_subcommand", subcmd: @match[1])
       end
     end
 

data/lib/ruby-debug/commands/variables.rb

@@ -1,8 +1,7 @@
 module Debugger
   module VarFunctions # :nodoc:
     def var_list(ary, b = get_binding)
-      ary.sort!
-      for v in ary
+      vars = ary.sort.map do |v|
         begin
           s = debug_eval(v.to_s, b).inspect
         rescue
@@ -15,13 +14,17 @@ module Debugger
         if s.size > self.class.settings[:width]
           s[self.class.settings[:width]-3 .. -1] = "..."
         end
-        print "%s = %s\n", v, s
+        [v, s]
       end
+      print prv(vars, 'instance')
     end
     def var_class_self
       obj = debug_eval('self')
       var_list(obj.class.class_variables, get_binding)
     end
+    def var_global
+      var_list(global_variables.reject { |v| [:$=, :$KCODE, :$-K].include?(v) })
+    end
   end
 
   # Implements the debugger 'var class' command.
@@ -59,15 +62,13 @@ module Debugger
     def execute
       obj = debug_eval(@match.post_match)
       if obj.kind_of? Module
-        constants = debug_eval("#{@match.post_match}.constants")
-        constants.sort!
-        for c in constants
-          next if c =~ /SCRIPT/
-          value = obj.const_get(c) rescue "ERROR: #{$!}"
-          print " %s => %p\n", c, value
+        constants = debug_eval("#{@match.post_match}.constants").sort.reject { |c| c =~ /SCRIPT/ }.map do |constant|
+          value = obj.const_get(constant) rescue "ERROR: #{$!}"
+          [constant, value]
         end
+        print prv(constants, "constant")
       else
-        print "Should be Class/Module: %s\n", @match.post_match
+        errmsg pr("variable.errors.not_class_module", object: @match.post_match)
       end
     end
 
@@ -90,7 +91,7 @@ module Debugger
     end
 
     def execute
-      var_list(global_variables)
+      var_global
     end
 
     class << self
@@ -108,11 +109,12 @@ module Debugger
 
   class VarInstanceCommand < Command # :nodoc:
     def regexp
-      /^\s*v(?:ar)?\s+ins(?:tance)?\s*/
+      # id will be read as first match, name as post match
+      /^\s*v(?:ar)?\s+ins(?:tance)?\s*((?:[\\+-]0x)[\dabcdef]+)?/
     end
 
     def execute
-      obj = debug_eval(@match.post_match.empty? ? 'self' : @match.post_match)
+      obj = get_obj(@match)
       var_list(obj.instance_variables, obj.instance_eval{binding()})
     end
 
@@ -123,10 +125,25 @@ module Debugger
 
       def help(cmd)
         %{
-          v[ar] i[nstance] <object>\tshow instance variables of object
+          v[ar] i[nstance] <object>\tshow instance variables of object. You may pass object id's hex as well.
         }
       end
     end
+
+    private
+
+      def get_obj(match)
+        obj = if match[1]
+          begin
+            ObjectSpace._id2ref(match[1].hex)
+          rescue RangeError
+            errmsg "Unknown object id : %s" % match[1]
+            nil
+          end
+        else
+          debug_eval(match.post_match.empty? ? 'self' : match.post_match)
+        end
+      end
   end
 
   # Implements the debugger 'var local' command.
@@ -136,11 +153,11 @@ module Debugger
     end
 
     def execute
-      locals = @state.context.frame_locals(@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
+      locals = []
+      _self = @state.context.frame_self(@state.frame_pos)
+      locals << ['self', _self] unless _self.to_s == "main"
+      locals += @state.context.frame_locals(@state.frame_pos).sort.map { |key, value| [key, value] }
+      print prv(locals, 'instance')
     end
 
     class << self

data/lib/ruby-debug/helper.rb

@@ -11,15 +11,15 @@ module Debugger
       begin
         int = Integer(str)
         if min and int < min
-          print "%s argument '%s' needs to at least %s.\n" % [cmd, str, min]
+          print Debugger.printer.print("parse.errors.int.too_low", cmd: cmd, str: str, min: min)
           return nil
         elsif max and int > max
-          print "%s argument '%s' needs to at most %s.\n" % [cmd, str, max]
+          print Debugger.printer.print("parse.errors.int.too_high", cmd: cmd, str: str, max: max)
           return nil
         end
         return int
       rescue
-        print "%s argument '%s' needs to be a number.\n" % [cmd, str]
+        print Debugger.printer.print("parse.errors.int.not_number", cmd: cmd, str: str)
         return nil
       end
     end
@@ -30,7 +30,7 @@ module Debugger
       if arg.nil? or arg == ''
         if default.nil?
           if print_error
-            print "Expecting 'on', 1, 'off', or 0. Got nothing.\n"
+            print Debugger.printer.print("parse.errors.onoff.syntax", arg: "nothing")
             raise RuntimeError
           end
           return default
@@ -43,7 +43,7 @@ module Debugger
         return false
       else
         if print_error
-          print "Expecting 'on', 1, 'off', or 0. Got: %s.\n" % arg.to_s
+          print Debugger.printer.print("parse.errors.onoff.syntax", arg: arg)
           raise RuntimeError
         end
       end

data/lib/ruby-debug/interface.rb

@@ -28,6 +28,18 @@ module Debugger
       print afmt(msg)
     end
 
+    def print_debug(msg)
+      print(msg)
+    end
+
+    private
+
+      def escape_input(args)
+        new_args = args.dup
+        new_args.first.gsub!("%", "%%") if args.first.is_a?(String)
+        new_args
+      end
+
   end
 
   class LocalInterface < Interface # :nodoc:
@@ -67,7 +79,7 @@ module Debugger
     end
     
     def print(*args)
-      STDOUT.printf(*args)
+      STDOUT.printf(*escape_input(args))
     end
     
     def close
@@ -169,7 +181,7 @@ module Debugger
     end
 
     def print(*args)
-      @socket.printf(*args)
+      @socket.printf(*escape_input(args))
     end
     
     private
@@ -222,7 +234,7 @@ module Debugger
     end
     
     def print(*args)
-      @out.printf(*args)
+      @out.printf(*escape_input(args))
     end
     
     def close

data/lib/ruby-debug/printers/base.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+module Printers
+  class Base
+    class MissedPath < StandardError; end
+    class MissedArgument < StandardError; end
+
+    SEPARATOR = "."
+
+    def type
+      self.class.name.split("::").last.downcase
+    end
+
+    private
+
+      def locate(path)
+        result = nil
+        contents.each do |_, contents|
+          result = parts(path).inject(contents) do |r, part|
+            r && r.has_key?(part) ? r[part] : nil
+          end
+          break if result
+        end
+        raise MissedPath, "Can't find part path '#{path}'" unless result
+        result
+      end
+
+      def translate(string, args = {})
+        string.gsub(/\|\w+$/, '').gsub(/{([^}]*)}/) do
+          key = $1.to_s.to_sym
+          raise MissedArgument, "Missed argument #{$1} for '#{string}'" unless args.has_key?(key)
+          args[key]
+        end
+      end
+
+      def parts(path)
+        path.split(SEPARATOR)
+      end
+
+      def contents
+        @contents ||= contents_files.inject({}) do |hash, filename|
+          hash[filename] = YAML.load_file(filename) || {}
+          hash
+        end
+      end
+
+      def array_of_args(collection, &block)
+        collection.each.with_index.inject([]) do |array, (item, index)|
+          args = block.call(item, index)
+          array << args if args
+          array
+        end
+      end
+
+      def contents_files
+        [File.expand_path(File.join("..", "texts", "base.yml"), __FILE__)]
+      end
+  end
+end

data/lib/ruby-debug/printers/plain.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+module Printers
+  class Plain < Base
+    include Columnize
+
+    def print(path, args = {})
+      message = translate(locate(path), args)
+      message << " (y/n) " if parts(path).include?("confirmations")
+      message << "\n"
+    end
+
+    def print_collection(path, collection, &block)
+      modifier = get_modifier(path)
+      lines = array_of_args(collection, &block).map { |args| print(path, args) }
+      if modifier == 'c'
+        columnize(lines.map { |l| l.gsub(/\n$/, '') }, Debugger.settings[:width])
+      else
+        lines.join("")
+      end
+    end
+
+    def print_variables(variables, _kind)
+      print_collection("variable.variable", variables) do |(key, value), _|
+        {key: key, value: value.nil? ? "nil" : value.to_s}
+      end
+    end
+
+    private
+
+      def get_modifier(path)
+        modifier_regexp = /\|(\w+)$/
+        modifier_match = locate(path).match(modifier_regexp)
+        modifier_match && modifier_match[1]
+      end
+
+      def contents_files
+        [File.expand_path(File.join("..", "texts", "plain.yml"), __FILE__)] + super
+      end
+
+  end
+end

data/lib/ruby-debug/printers/texts/base.yml

@@ -0,0 +1,146 @@
+base:
+  errors:
+    no_suspended_thread: "There is no thread suspended at the time and therefore no context to execute '{input}'"
+    command_unavailable: "Command is unavailable"
+    unknown_command: "Unknown command: {input}"
+
+breakpoints:
+  errors:
+    if: "Expecting 'if' in breakpoint condition; got: {expr}"
+    location: "Invalid breakpoint location: {expr}"
+    state: "We are not in a state that has an associated file"
+    class: "Unknown class {file}"
+    far_line: "There are only {lines} lines in file '{file}'"
+    source: "No source file named {file}"
+    state_add: "We are not in a state we can add breakpoints"
+    state_delete: "We are not in a state we can delete breakpoints"
+    expression: "Expression '{expr}' syntactically incorrect; breakpoint disabled"
+    no_breakpoint: "No breakpoint number {id}"
+  confirmations:
+    set_breakpoint: "Set breakpoint anyway?"
+    delete_all: "Delete all breakpoints?"
+
+condition:
+  errors:
+    syntax: "'condition' must be followed a breakpoint number and expression"
+    no_breakpoints: "No breakpoints have been set"
+
+continue:
+  errors:
+    unstopped_line: "Line {line} is not a stopping point in file '{file}'"
+
+display:
+  confirmations:
+    clear_all: "Clear all expressions?"
+  errors:
+    undefined: "Display expression {expr} is not defined"
+
+edit:
+  errors:
+    state: "We are not in a state that has an associated file"
+    file_line: "Invalid file/line number specification: {file_line}"
+    not_readable: "File '{file}' is not readable"
+
+frame:
+  errors:
+    too_low: "Adjusting would put us beyond the oldest (initial) frame"
+    too_high: "Adjusting would put us beyond the newest (innermost) frame"
+
+jump:
+  errors:
+    no_line_number: "'jump' must be followed by a line number"
+    bad_line_number: "Bad line number: {line}"
+    not_possible: "Not possible to jump from here"
+    no_frame: "Couldn't find debugged frame"
+    no_active_code: "Couldn't find active code at {file}:{line}"
+
+quit:
+  confirmations:
+    really: "Really quit?"
+
+reload:
+  messages:
+    done: "Source code is reloaded. Automatic reloading is {source_reloading}"
+
+restart:
+  errors:
+    undefined: "Don't know name of debugged program"
+    not_exist: "Ruby program {prog} doesn't exist"
+    no_args: "Arguments have not been set. Use 'set args' to set them"
+    not_available: "Restart command is not available at this time"
+  debug:
+    outset: "Debugger was not called from the outset..."
+    change_initial_dir: "Failed to change initial directory {dir}"
+    not_executable: "Ruby program {prog} doesn't seem to be executable...\nWe'll add a call to Ruby"
+
+save:
+  messages:
+    done: "Saved to '{path}'"
+
+set:
+  errors:
+    invalid_call_style: "Invalid call style {style}. Should be one of: 'short' or 'last'"
+    wrong_history_arg: "Invalid history parameter {arg}. Should be 'filename', 'save' or 'size'"
+    wrong_history_args_number: "Need two parameters for 'set history'; got {size}"
+    unknown_setting: "Unknown setting {setting}"
+    unknown_subcommand: "Unknown set command {subcmd}"
+
+show:
+  messages:
+    annotation: "Annotation level is {level}"
+    args: "Argument list to give program being debugged when it is started is '{args}'"
+    general: "{setting} is {status}"
+    call_style: "Frame call-display style is {style}"
+    debuggertesting: "Currently testing the debugger is {status}"
+    fullpath: "Displaying frame's full file names is {status}"
+    history:
+      filename: "{prefix}The filename in which to record the command history is '{filename}'"
+      save: "{prefix}Saving of history save is {status}"
+      size: "{prefix}Debugger history size is {size}"
+    tracing_plus:
+      'on': "line tracing style is different consecutive lines"
+      'off': "line tracing style is every line"
+    listsize: "Number of source lines to list by default is {size}"
+    port: "server port is {port}"
+    version: "ruby-debug {version}"
+  errors:
+    no_readline: "No readline support"
+    unknown_subcommand: "Unknown show subcommand {name}"
+    unknown: "Unknown show command {name}"
+
+skip:
+  messages:
+    ok: "ok"
+
+source:
+  errors:
+    not_found: "Command file '{file}' is not found"
+
+thread:
+  errors:
+    no_number: "'{subcmd}' needs a thread number"
+    no_thread: "No such thread"
+    current_thread: "It's the current thread"
+    wrong_action: "Can't {subcmd} to the debugger thread {arg}"
+    already_running: "Already running"
+    debug_trace: "DebuggerThread are not supposed to be traced ({thread})"
+
+toggle:
+  errors:
+    no_breakpoints: "No breakpoints have been set"
+    no_display: "No display expressions have been set"
+    syntax: "'{toggle}' must be followed 'display', 'breakpoints' or breakpoint numbers"
+    expression: "Expression '{expr}' syntactically incorrect; breakpoint remains disabled"
+
+parse:
+  errors:
+    int:
+      too_low: "{cmd} argument '{str}' needs to at least {min}"
+      too_high: "{cmd} argument '{str}' needs to at most {max}"
+      not_number: "{cmd} argument '{str}' needs to be a number"
+    onoff:
+      syntax: "Expecting 'on', 1, 'off', or 0. Got {arg}"
+
+variable:
+  errors:
+    not_class_module: "Should be Class/Module: {object}"