debugger-xml 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fe797dc2d6d07beba865c6d7dfe1a2cd71e6927
-  data.tar.gz: 5cee2ad6bca4e73ba710bca6e8667f05f49e806a
+  metadata.gz: 19c5d53c2123f938edfb1309c441c1f9c936531d
+  data.tar.gz: 6b287e9a8e24e25bae59e50c451d60fee31796cd
 SHA512:
-  metadata.gz: 79b07ae2c79d223ff04ffbe0368677470ba35ac482cb660726ee669abe36422e9b7e50316363c56970031592be256b4632df14e57c07385cd92be0f23d0c3323
-  data.tar.gz: 0a187a786b414758660275a9916a63d2c21ee57c597b002f2dfcab41674d96d73c772094d726f2462f299af4c91a90106e6b9a5b42382b2feffbd71ec08b019b
+  metadata.gz: 1df8f6145823191d66d20a0526c4ba9c8bade1f74b2dbb28ea5ccf76c4e1772449b88cfde48b1e089db253b177e50f111e4f03b2ba973b57335f2c5c401ea1bf
+  data.tar.gz: e57ff1a5591d10e6e18ea2732fbc6c85b896df40f2fff73094c094fac8a145b5abbc39a736e0d6dc5276f1c9faee20c39e4eab39b6095fd682687b9b9146294b

data/README.md

@@ -1,6 +1,6 @@
 ## Description
 
-This is a gem, which adds the XML printer to the 'debugger' gem, using the same API as
+This is a gem, which adds the XML printer to the 'debugger' or 'byebug' gems, using the same API as
 the ruby-debug-ide gem, which allows it to be used with Ruby IDEs (for example, in my
 vim-ruby-debugger :))
 

data/bin/rdebug-ide

@@ -12,14 +12,17 @@ class RdebugIde
 
   def initialize
     check_argv!
-    Debugger.const_set("ARGV", ARGV.clone)
-    Debugger.const_set("RDEBUG_SCRIPT", rdebug_path)
-    install_interruption_handler if options.int_handler
-    Debugger.tracing = options.tracing
-    Debugger.wait_for_start = options.wait_for_start
-    Debugger.wait_connection = true
-    Debugger.printer = Printers::Xml.new
-    Debugger.const_set("PROG_SCRIPT", ARGV.shift)
+    @proxy = DebuggerXml::DebuggerProxy.new
+    @proxy.set_argv(ARGV.clone)
+    @proxy.set_rdebug_script(rdebug_path)
+    @proxy.set_prog_script(ARGV.shift)
+    if options.int_handler
+      install_interruption_handler
+    end
+    @proxy.tracing = options.tracing
+    @proxy.printer = Printers::Xml.new
+    @proxy.wait_connection = true
+    DebuggerXml.wait_for_start = options.wait_for_start
     Debugger::Xml.logger = if options.debug_mode
       Debugger::Xml::Ide::Logger.new
     else
@@ -59,7 +62,7 @@ class RdebugIde
     end
 
     def install_interruption_handler
-      trap('INT') { Debugger.interrupt_last }
+      trap('INT') { @proxy.interrupt_last }
     end
 
     def rdebug_path

data/bin/rdebug-vim

@@ -3,29 +3,46 @@
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 require 'optparse'
 require 'ostruct'
-require 'debugger'
-require 'debugger/xml'
+
+DEBUGGER_TYPE = if RUBY_VERSION < "2.0"
+  require 'debugger'
+  :debugger
+else
+  require 'byebug'
+  :byebug
+end
+
+require 'debugger_xml'
+
+if DEBUGGER_TYPE == :debugger
+  PROXY_CLASS = DebuggerXml::DebuggerProxy
+  PRINTER_CLASS = Printers::Xml
+else
+  PROXY_CLASS = DebuggerXml::ByebugProxy
+  PRINTER_CLASS = Byebug::Printers::Xml
+end
 
 class RdebugVim
 
   def initialize
     check_argv!
-    Debugger.const_set("RDEBUG_SCRIPT", File.expand_path($0))
+    DebuggerXml.wait_for_start = true
+    @proxy = PROXY_CLASS.new
+    @proxy.tracing = false
+    @proxy.printer = PRINTER_CLASS.new
+    @proxy.set_rdebug_script(File.expand_path($0))
+    @proxy.set_prog_script(options.script)
     install_interruption_hander
-    Debugger.tracing = false
-    Debugger.wait_for_start = true
-    Debugger.printer = Printers::Xml.new
-    Debugger.const_set("PROG_SCRIPT", options.script)
-    Debugger::Xml.logger = if options.debug_mode
-       Debugger::Xml::Vim::Logger.new(options.logger_file)
+    DebuggerXml.logger = if options.debug_mode
+      DebuggerXml::Vim::Logger.new(options.logger_file)
     else
-       Debugger::Xml::FakeLogger.new
+      DebuggerXml::FakeLogger.new
     end
   end
 
   def run
-    Debugger.start_for_vim(options)
-    bt = Debugger.debug_load(Debugger::PROG_SCRIPT, false, false)
+    DebuggerXml.start_for_vim(@proxy, options)
+    bt = @proxy.debug_load
     if bt
       print bt.backtrace.map{|l| "\t#{l}"}.join("\n"), "\n"
       print "Uncaught exception: #{bt}\n"
@@ -44,7 +61,7 @@ class RdebugVim
     end
 
     def install_interruption_hander
-      trap('INT') { Debugger.interrupt_last }
+      trap('INT') { @proxy.interrupt_last }
     end
 
     def options

data/debugger-xml.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'debugger/xml/version'
+require 'debugger_xml/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "debugger-xml"
-  gem.version       = Debugger::Xml::VERSION
+  gem.version       = DebuggerXml::VERSION
   gem.authors       = ["Anton Astashov"]
   gem.email         = ["anton.astashov@gmail.com"]
   gem.description   = %q{XML interface for debugger}
@@ -18,7 +18,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "debugger", '>= 1.6.2'
+  if RUBY_VERSION < "2.0"
+    gem.add_dependency 'debugger'
+  else
+    gem.add_dependency 'byebug'
+  end
   gem.add_dependency 'builder', '>= 2.0.0'
   gem.add_development_dependency 'rake', '~> 0.9.2.2'
   gem.add_development_dependency 'minitest', '~> 2.12.1'

data/lib/byebug/commands/frame.rb

@@ -0,0 +1,16 @@
+module Byebug
+  module FrameFunctions
+
+    # Mark should be 'true' or 'false', as a String
+    def get_pr_arguments_with_xml(pos, mark = nil)
+      mark = (pos == @state.frame_pos).to_s
+      res = get_pr_arguments_without_xml(pos, mark)
+      res[:file] = File.expand_path(res[:file])
+      res
+    end
+
+    alias_method :get_pr_arguments_without_xml, :get_pr_arguments
+    alias_method :get_pr_arguments, :get_pr_arguments_with_xml
+
+  end
+end

data/lib/byebug/commands/help.rb

@@ -0,0 +1,13 @@
+module Byebug
+  class HelpCommand < Command
+
+    def execute_with_xml(*args)
+      errmsg(pr("general.errors.unsupported", cmd: 'help')) && return if Byebug.printer.type == "xml"
+      execute_without_xml(*args)
+    end
+
+    alias_method :execute_without_xml, :execute
+    alias_method :execute, :execute_with_xml
+
+  end
+end

data/lib/byebug/commands/info.rb

@@ -0,0 +1,13 @@
+module Byebug
+  class InfoCommand < Command
+
+    def execute_with_xml(*args)
+      errmsg(pr("general.errors.unsupported", cmd: 'info')) && return if Byebug.printer.type == "xml"
+      execute_without_xml(*args)
+    end
+
+    alias_method :execute_without_xml, :execute
+    alias_method :execute, :execute_with_xml
+
+  end
+end

data/lib/byebug/commands/inspect.rb

@@ -0,0 +1,30 @@
+module Byebug
+  class InspectCommand < Command
+    # reference inspection results in order to save them from the GC
+    @@references = []
+    def self.reference_result(result)
+      @@references << result
+    end
+    def self.clear_references
+      @@references = []
+    end
+
+    def regexp
+      /^\s*v(?:ar)?\s+inspect\s+/
+    end
+
+    def execute
+      run_with_binding do |binding|
+        obj = debug_eval(@match.post_match, binding)
+        InspectCommand.reference_result(obj)
+        print prv({eval_result: obj}, "local")
+      end
+    end
+
+    def help
+      %{
+        v[ar] instpect <object>\tinpect a given object (supposed to be used only from ide)
+      }
+    end
+  end
+end

data/lib/byebug/commands/kill.rb

@@ -0,0 +1,13 @@
+module Byebug
+  class KillCommand < Command
+
+    def execute_with_xml(*args)
+      errmsg(pr("general.errors.unsupported", cmd: 'kill')) && return if Byebug.printer.type == "xml"
+      execute_without_xml(*args)
+    end
+
+    alias_method :execute_without_xml, :execute
+    alias_method :execute, :execute_with_xml
+
+  end
+end

data/lib/byebug/commands/start.rb

@@ -0,0 +1,25 @@
+module Byebug
+  class StartCommand < Command # :nodoc:
+    self.allow_in_control = true
+
+    def regexp
+      /^\s*(start)\s*$/ix
+    end
+
+    def execute
+      DebuggerXml.proceed
+    end
+
+    class << self
+      def help_command
+        'start'
+      end
+
+      def help(cmd)
+        %{
+          run prog script
+        }
+      end
+    end
+  end
+end

data/lib/byebug/commands/threads.rb

@@ -0,0 +1,10 @@
+module Byebug
+  module ThreadFunctions # :nodoc:
+    def thread_arguments_with_pid(context, should_show_top_frame = true)
+      thread_arguments_without_pid(context, should_show_top_frame).merge(pid: Process.pid)
+    end
+
+    alias_method :thread_arguments_without_pid, :thread_arguments
+    alias_method :thread_arguments, :thread_arguments_with_pid
+  end
+end

data/lib/byebug/commands/trace.rb

@@ -0,0 +1,13 @@
+module Byebug
+  class TracevarCommand < Command
+
+    def execute_with_xml(*args)
+      errmsg(pr("general.errors.unsupported", cmd: 'trace')) && return if Byebug.printer.type == "xml"
+      execute_without_xml(*args)
+    end
+
+    alias_method :execute_without_xml, :execute
+    alias_method :execute, :execute_with_xml
+
+  end
+end

data/lib/byebug/commands/variables.rb

@@ -0,0 +1,54 @@
+module Byebug
+  module VarFunctions # :nodoc:
+
+    def var_global
+      var_list(global_variables.reject { |v| [:$=, :$KCODE, :$-K, :$FILENAME].include?(v) })
+    end
+
+  end
+  class VarInstanceCommand < Command
+
+    def execute_with_xml(*args)
+      if Byebug.printer.type == "xml"
+        DebuggerXml.logger.puts("match: #{@match}")
+        DebuggerXml.logger.puts("THE OBJ: #{get_obj(@match).inspect}")
+        print Byebug.printer.print_instance_variables(get_obj(@match))
+      else
+        execute_without_xml(*args)
+      end
+    end
+
+    alias_method :execute_without_xml, :execute
+    alias_method :execute, :execute_with_xml
+
+    private
+
+    def get_obj(match)
+      if match[1]
+        begin
+          DebuggerXml.logger.puts("Getting object space")
+          ObjectSpace._id2ref(match[1].hex)
+        rescue RangeError
+          errmsg "Unknown object id : %s" % match[1]
+          nil
+        end
+      else
+        bb_warning_eval(match.post_match.empty? ? 'self' : match.post_match)
+      end
+    end
+  end
+
+  class VarIdeCommand < Command
+    def regexp
+      /^\s*v(?:ar)?\s+ide\s*$/
+    end
+
+    def execute
+      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
+  end
+end

data/lib/byebug/context_xml.rb

@@ -0,0 +1,29 @@
+module Byebug
+  class Context
+    class << self
+      IGNORED_XML_FILES = Dir.glob(File.expand_path('../../../**/*', __FILE__))
+
+      def stack_size(byebug_frames = false)
+        backtrace = Thread.current.backtrace_locations(0)
+        return 0 unless backtrace
+
+        unless byebug_frames
+          backtrace = backtrace.select { |l| !ignored(l.path) }
+        end
+        backtrace.size
+      end
+
+      def ignored_with_xml(path)
+        result = ignored_without_xml(path) ||
+          IGNORED_XML_FILES.include?(path) ||
+          !!path.match(/^\(eval\)/) ||
+          !!path.match(/rdebug-vim$/) ||
+          !!path.match(/rdebug-ide$/)
+        result
+      end
+
+      alias_method :ignored_without_xml, :ignored
+      alias_method :ignored, :ignored_with_xml
+    end
+  end
+end

data/lib/byebug/printers/texts/xml.yml

@@ -0,0 +1,122 @@
+general:
+  errors:
+    unsupported: "Unsupported command '{cmd}'"
+
+breakpoints:
+  set_breakpoint_to_line:
+    tag: breakpointAdded
+    attributes:
+      "no": "{id}"
+      location: "{file}:{line}"
+  set_breakpoint_to_method:
+    tag: breakpointAdded
+    attributes:
+      "no": "{id}"
+      method: "{class}::{method}"
+  stop_at_breakpoint:
+    tag: breakpoint
+    attributes:
+      file: "{file}"
+      line: "{line}"
+      threadId: "{thread_id}"
+  delete:
+    tag: breakpointDeleted
+    attributes:
+      "no": "{id}"
+
+conditions:
+  set_condition:
+    tag: conditionSet
+    attributes:
+      bp_id: "{id}"
+  unset_condition:
+    tag: conditionSet # Would ideally be conditionUnset, but we keep compatibility with old ruby-debug-ide
+    attributes:
+      bp_id: "{id}"
+
+display:
+  result:
+    tag: display
+    attributes:
+      key: "{exp}"
+      value: "{result}"
+
+eval:
+  exception:
+    tag: processingException
+    attributes:
+      type: "{class}"
+      message: "{value}"
+  result:
+    tag: eval
+    attributes:
+      expression: "{expr}"
+      value: "{result}"
+
+frame:
+  line:
+    tag: frame
+    attributes:
+      "no": "{pos}"
+      file: "{file}"
+      line: "{line}"
+      current: "{mark}"
+
+method:
+  methods:
+    tag: method
+    attributes:
+      name: "{name}"
+
+stop:
+  suspend:
+    tag: suspended
+    attributes:
+      file: "{file}"
+      line: "{line_number}"
+      threadId: "{thnum}"
+      frames: "{frames}"
+
+toggle:
+  breakpoint_enabled:
+    tag: breakpointEnabled
+    attributes:
+      bp_id: "{id}"
+  breakpoint_disabled:
+    tag: breakpointDisabled
+    attributes:
+      bp_id: "{id}"
+
+restart:
+  success:
+    tag: restart
+    attributes:
+      command: "{cmd}"
+
+set:
+  errors:
+    no_subcommand: "'set' must be followed by the name of a subcommand"
+
+show:
+  errors:
+    no_subcommand: "'show' must be followed by the name of a subcommand"
+
+thread:
+  context:
+    tag: thread
+    attributes:
+      id: "{id}"
+      status: "{status}"
+      current: "{current}"
+      pid: "{pid}"
+
+variable:
+  variable:
+    tag: variable
+    attributes:
+      name: "{name}"
+      kind: "{kind}"
+      value: "{value}"
+      type: "{type}"
+      hasChildren: "{has_children}"
+      objectId: "{id}"