Merge pull request #72 from ruby-debug/file-filtering

File filtering (in progress)

Author: os97673

ChangeLog.md

@@ -1,3 +1,9 @@
+## [master](https://github.com/ruby-debug/ruby-debug-ide/compare/v0.5.0...master)
+
+* "file-filter on|off" command added
+* "include file|dir" command added
+* "exclude file|dir" command added
+
 ## [0.5.0](https://github.com/ruby-debug/ruby-debug-ide/compare/v0.4.33...v0.5.0)
 
 * catchpointDeleted event added (under --catchpoint-deleted-event flag)

lib/ruby-debug-ide.rb

@@ -108,9 +108,7 @@ def start_control(host, port, notify_dispatcher)
           # "localhost" and nil have problems on some systems.
           host ||= '127.0.0.1'
           server = TCPServer.new(host, port)
-          gem_name = (defined?(JRUBY_VERSION) || RUBY_VERSION < '1.9.0') ? 'ruby-debug-base' :
-              RUBY_VERSION < '2.0.0' ? 'ruby-debug-base19x' : 'debase'
-          $stderr.printf "Fast Debugger (ruby-debug-ide #{IDE_VERSION}, #{gem_name} #{VERSION}) listens on #{host}:#{port}\n"
+          print_greeting_msg(host, port)
           notify_dispatcher(port) if notify_dispatcher
 
           while (session = server.accept)
@@ -138,8 +136,26 @@ def start_control(host, port, notify_dispatcher)
       end
     end
 
+    def print_greeting_msg(host, port)
+      base_gem_name = if defined?(JRUBY_VERSION) || RUBY_VERSION < '1.9.0'
+        'ruby-debug-base'
+      elsif RUBY_VERSION < '2.0.0'
+        'ruby-debug-base19x'
+      else
+        'debase'
+      end
+
+      file_filtering_support = if Command.file_filter_supported?
+       'supported'
+      else
+       'not supported'
+      end
+      $stderr.printf "Fast Debugger (ruby-debug-ide #{IDE_VERSION}, #{base_gem_name} #{VERSION}, file filtering is #{file_filtering_support}) listens on #{host}:#{port}\n"
+    end
+
     private
 
+
     def notify_dispatcher(port)
       return unless ENV['IDE_PROCESS_DISPATCHER']
       acceptor_host, acceptor_port = ENV['IDE_PROCESS_DISPATCHER'].split(":")

lib/ruby-debug-ide/command.rb

@@ -70,6 +70,10 @@ def unescape_incoming(str)
           $1 + "\n" * ($2.size / 2)
         end.gsub(/\\\\/, '\\')
       end
+
+      def file_filter_supported?
+        defined?(Debugger.file_filter)
+      end
     end
 
     def initialize(state, printer)
@@ -145,7 +149,18 @@ def line_at(file, line)
 
     def get_context(thnum)
       Debugger.contexts.find{|c| c.thnum == thnum}
-    end  
+    end
+
+    def realpath(filename)
+      if filename.index(File::SEPARATOR) || File::ALT_SEPARATOR && filename.index(File::ALT_SEPARATOR)
+        filename = File.expand_path(filename)
+      end
+      if (RUBY_VERSION < '1.9') || (RbConfig::CONFIG['host_os'] =~ /mswin/)
+        filename
+      else
+        File.realpath(filename) rescue filename
+      end
+    end
   end
 
   Command.load_commands

lib/ruby-debug-ide/commands/breakpoints.rb

@@ -62,17 +62,6 @@ def help(cmd)
         }
       end
     end
-
-    private
-      def realpath(filename)
-        filename = File.expand_path(filename) if filename.index(File::SEPARATOR) || \
-            File::ALT_SEPARATOR && filename.index(File::ALT_SEPARATOR)
-        if (RUBY_VERSION < '1.9') || (RbConfig::CONFIG['host_os'] =~ /mswin/)
-          filename
-        else
-          File.realpath(filename) rescue filename
-        end
-      end
   end
 
   class BreakpointsCommand < Command # :nodoc:

lib/ruby-debug-ide/commands/file_filtering.rb

@@ -0,0 +1,107 @@
+module Debugger
+  class IncludeFile < Command # :nodoc:
+    self.control = true
+
+    def regexp
+      / ^\s*include\s+(.+?)\s*$/x
+    end
+
+    def execute
+      file = @match[1]
+
+      return if file.nil?
+      file = realpath(file)
+
+      if Command.file_filter_supported?
+        Debugger.file_filter.include(file)
+        print_file_included(file)
+      else
+        print_debug("file filter is not supported")
+      end
+    end
+
+    class << self
+      def help_command
+        'include'
+      end
+
+      def help(cmd)
+        %{
+          include file - adds file/dir to file filter (either remove already excluded or add as included)
+        }
+      end
+    end
+  end
+
+  class ExcludeFile < Command # :nodoc:
+    self.control = true
+
+    def regexp
+      / ^\s*exclude\s+(.+?)\s*$/x
+    end
+
+    def execute
+      file = @match[1]
+
+      return if file.nil?
+      file = realpath(file)
+
+      if Command.file_filter_supported?
+        Debugger.file_filter.exclude(file)
+        print_file_excluded(file)
+      else
+        print_debug("file filter is not supported")
+      end
+    end
+
+    class << self
+      def help_command
+        'include'
+      end
+
+      def help(cmd)
+        %{
+          exclude file - exclude file/dir from file filter (either remove already included or add as exclude)
+        }
+      end
+    end
+  end
+
+  class FileFilterCommand < Command # :nodoc:
+    self.control = true
+
+    def regexp
+      / ^\s*file-filter\s+(on|off)\s*$/x
+    end
+
+    def execute
+      action = @match[1]
+
+      if Command.file_filter_supported?
+        if 'on' == action
+          Debugger.file_filter.enable
+          print_file_filter_status(true)
+        elsif 'off' == action
+          Debugger.file_filter.disable
+          print_file_filter_status(false)
+        else
+          print_error "Unknown option '#{action}'"
+        end
+      else
+        print_debug("file filter is not supported")
+      end
+    end
+
+    class << self
+      def help_command
+        'file-filter'
+      end
+
+      def help(cmd)
+        %{
+          file-filter (on|off) - enable/disable file  filtering
+        }
+      end
+    end
+  end
+end

lib/ruby-debug-ide/version.rb

@@ -1,3 +1,3 @@
 module Debugger
-  IDE_VERSION='0.5.0'
+  IDE_VERSION='0.6.0.pre1'
 end

lib/ruby-debug-ide/xml_printer.rb

@@ -184,6 +184,18 @@ def print_variable(name, value, kind)
             CGI.escapeHTML(name), kind, CGI.escapeHTML(safe_to_string(value)))
     end
 
+    def print_file_included(file)
+      print("<fileIncluded file=\"%s\"/>", file)
+    end
+
+    def print_file_excluded(file)
+      print("<fileExcluded file=\"%s\"/>", file)
+    end
+
+    def print_file_filter_status(status)
+      print("<fileFilter status=\"%s\"/>", status)
+    end
+
     def print_breakpoints(breakpoints)
       print_element 'breakpoints' do
         breakpoints.sort_by{|b| b.id }.each do |b|