Merge pull request #35 from ahuff44/improvements

Improvements (clear marks, jump to next/prev result, show previews on hover)

Author: leonid-shevtsov

Default (Linux).sublime-keymap

@@ -1,3 +1,3 @@
 [
-    { "keys": ["alt+ctrl+shift+f"], "command": "search_in_project" }
+    { "keys": ["alt+ctrl+shift+f"], "command": "search_in_project", "args": { "type": "search" } }
 ]

Default (OSX).sublime-keymap

@@ -1,3 +1,3 @@
 [
-    { "keys": ["alt+super+shift+f"], "command": "search_in_project" }
+    { "keys": ["alt+super+shift+f"], "command": "search_in_project", "args": { "type": "search" } }
 ]

Default (Windows).sublime-keymap

@@ -1,3 +1,3 @@
 [
-    { "keys": ["alt+ctrl+shift+f"], "command": "search_in_project" }
+    { "keys": ["alt+ctrl+shift+f"], "command": "search_in_project", "args": { "type": "search" } }
 ]

Default.sublime-commands

@@ -1,7 +1,19 @@
 [
   {
-    "caption": "Search In Project",
-    "command": "search_in_project"
+    "caption": "SearchInProject: Search",
+    "command": "search_in_project", "args": {"type": "search"},
+  },
+  {
+    "caption": "SearchInProject: Clear results",
+    "command": "search_in_project", "args": {"type": "clear"},
+  },
+  {
+    "caption": "SearchInProject: Next result",
+    "command": "search_in_project", "args": {"type": "next"},
+  },
+  {
+    "caption": "SearchInProject: Previous result",
+    "command": "search_in_project", "args": {"type": "prev"},
   },
   {
     "caption": "Preferences: Search in Project Settings – Default",

README.md

@@ -9,7 +9,7 @@ It opens a quick selection panel to browse results, and highlights matches insid
 ## Usage
 
 * Use the key binding (`⌘⌥⇧F` on OS X, `Ctrl+Alt+Shift+F` on Windows and Linux), or
-* Call the "Search in Project" command;
+* Call the "SearchInProject: Search" command;
 * Enter the search query;
 * Hit `Enter` (`Return`). You'll be presented with a "quick select" panel with the search results. Select any file from that panel (it supports fuzzy searching) to go to the match. The search string will be highlighted with an outline and a circle symbol in the gutter area.
 * The last item on the quick select panel is "List results in view". Pick it to see results in a regular editor view. (Tip: if you enter three ticks ("`") in the search box - it's going to be to be the first item.)
@@ -32,7 +32,7 @@ My idea is that if you use this plugin it's because you already use one of the s
 
 The supported search engines are:
 
-Name | Description | Search in Project key 
+Name | Description | Search in Project key
 ---- | ----------- | ---------------------
 **[pt (The Platinum Searcher)](https://github.com/monochromegane/the_platinum_searcher)** | **fast, has binaries for every platform, recommended.** | `the_platinum_searcher`
 **[ag (The Silver Searcher)](http://geoff.greer.fm/ag/)** | **equally fast, only 3rd party binaries for Windows, also recommended** | `the_silver_searcher`

search_in_project.py

@@ -35,29 +35,43 @@ class SearchInProjectCommand(sublime_plugin.WindowCommand):
 
     def __init__(self, window):
         sublime_plugin.WindowCommand.__init__(self, window)
+        self.results = []
         self.last_search_string = ''
-        pass
-
-    def run(self):
-        self.settings = sublime.load_settings('SearchInProject.sublime-settings')
-        self.engine_name = self.settings.get("search_in_project_engine")
-        pushd = os.getcwd()
-        os.chdir(basedir)
-        __import__("searchengines.%s" % self.engine_name)
-        self.engine = searchengines.__dict__[self.engine_name].engine_class(self.settings)
-        os.chdir(pushd)
-        view = self.window.active_view()
-        selection_text = view.substr(view.sel()[0])
-        self.window.show_input_panel(
-            "Search in project:",
-            not "\n" in selection_text and selection_text or self.last_search_string,
-            self.perform_search, None, None)
-        pass
+        self.last_selected_result_index = 0
+        self.saved_view = None
+
+    def run(self, type="search"):
+        if type == "search":
+            self.settings = sublime.load_settings('SearchInProject.sublime-settings')
+            self.engine_name = self.settings.get("search_in_project_engine")
+            pushd = os.getcwd()
+            os.chdir(basedir)
+            __import__("searchengines.%s" % self.engine_name)
+            self.engine = searchengines.__dict__[self.engine_name].engine_class(self.settings)
+            os.chdir(pushd)
+            view = self.window.active_view()
+            selection_text = view.substr(view.sel()[0])
+            self.saved_view = view
+            panel_view = self.window.show_input_panel(
+                "Search in project:",
+                not "\n" in selection_text and selection_text or self.last_search_string,
+                self.perform_search, None, None)
+            panel_view.run_command("select_all")
+        elif type == "clear":
+            self.clear_markup()
+        elif type == "next":
+            self.goto_relative_result(1)
+        elif type == "prev":
+            self.goto_relative_result(-1)
+        else:
+            raise Exception("unrecognized type \"%s\""%type)
 
     def perform_search(self, text):
         if not text:
             return
 
+        if self.last_search_string != text:
+            self.last_selected_result_index = 0
         self.last_search_string = text
         folders = self.search_folders()
 
@@ -67,24 +81,60 @@ def perform_search(self, text):
             if self.results:
                 self.results = [[result[0].replace(self.common_path.replace('\"', ''), ''), result[1][:self.MAX_RESULT_LINE_LENGTH]] for result in self.results]
                 self.results.append("``` List results in view ```")
-                self.window.show_quick_panel(self.results, self.goto_result)
+                flags = 0
+                self.window.show_quick_panel(
+                    self.results,
+                    self.goto_result,
+                    flags,
+                    self.last_selected_result_index,
+                    self.on_highlighted)
             else:
                 self.results = []
                 sublime.message_dialog('No results')
         except Exception as e:
             self.results = []
             sublime.error_message("%s running search engine %s:"%(e.__class__.__name__,self.engine_name) + "\n" + str(e))
 
+    def on_highlighted(self, file_no):
+        self.last_selected_result_index = file_no
+        if file_no != -1 and file_no != len(self.results) - 1: # last result is "list in view"
+            self.open_and_highlight_file(file_no, transient=True)
+
+    def open_and_highlight_file(self, file_no, transient=False):
+        file_name_and_col = self.common_path.replace('\"', '') + self.results[file_no][0]
+        flags = sublime.ENCODED_POSITION
+        if transient:
+            flags |= sublime.TRANSIENT
+        view = self.window.open_file(file_name_and_col, flags)
+
+        regions = view.find_all(self.last_search_string, sublime.IGNORECASE)
+        view.add_regions("search_in_project", regions, "entity.name.filename.find-in-files", "circle", sublime.DRAW_OUTLINED)
 
     def goto_result(self, file_no):
-        if file_no != -1:
+        if file_no == -1:
+            self.clear_markup()
+            self.window.focus_view(self.saved_view)
+        else:
             if file_no == len(self.results) - 1: # last result is "list in view"
                 self.list_in_view()
             else:
-                file_name = self.common_path.replace('\"', '') + self.results[file_no][0]
-                view = self.window.open_file(file_name, sublime.ENCODED_POSITION)
-                regions = view.find_all(self.last_search_string)
-                view.add_regions("search_in_project", regions, "entity.name.filename.find-in-files", "circle", sublime.DRAW_OUTLINED)
+                self.open_and_highlight_file(file_no)
+
+    def goto_relative_result(self, offset):
+        if self.last_search_string:
+            new_index = self.last_selected_result_index + offset
+            if 0 <= new_index < len(self.results) - 1: # last result is "list in view"
+                self.last_selected_result_index = new_index
+                self.goto_result(new_index)
+
+    def clear_markup(self):
+        for result in self.results[:-1]: # every result except the last one (the "list in view")
+            file_name_and_col = self.common_path.replace('\"', '') + result[0]
+            file_name = file_name_and_col.split(':')[0]
+            view = self.window.find_open_file(file_name)
+            if view: # if the view is no longer open, do nothing
+                view.erase_regions("search_in_project")
+        self.results = []
 
     def list_in_view(self):
         self.results.pop()