Hide, don't delete messages when dismissed. (#295)

* Hide, don't delete messages when dismissed.

When dismissing messages, hide them and allow the user to bring them back
(using a command such as List Messages or Next/Prev).

* Fix opening view with messages after dismissing all messages.

Author: ehuss

cargo_build.py

@@ -236,7 +236,11 @@ def on_load(self, view):
     def on_query_context(self, view, key, operator, operand, match_all):
         # Used by the Escape-key keybinding to dismiss inline phantoms.
         if key == 'rust_has_messages':
-            has_messages = view.window().id() in messages.WINDOW_MESSAGES
+            try:
+                winfo = messages.WINDOW_MESSAGES[view.window().id()]
+                has_messages = not winfo['hidden']
+            except KeyError:
+                has_messages = False
             if operator == sublime.OP_EQUAL:
                 return operand == has_messages
             elif operator == sublime.OP_NOT_EQUAL:
@@ -287,7 +291,7 @@ class RustDismissMessagesCommand(sublime_plugin.WindowCommand):
     """Removes all inline messages."""
 
     def run(self):
-        messages.clear_messages(self.window)
+        messages.clear_messages(self.window, soft=True)
 
 
 class RustListMessagesCommand(sublime_plugin.WindowCommand):
@@ -500,6 +504,17 @@ def run(self, edit, region, replacement):
         self.view.replace(edit, region, replacement)
 
 
+class RustScrollToRegion(sublime_plugin.TextCommand):
+
+    """Internal command used to scroll a view to a region."""
+
+    def run(self, edit, region):
+        r = sublime.Region(*region)
+        self.view.sel().clear()
+        self.view.sel().add(r)
+        self.view.show_at_center(r)
+
+
 def plugin_unloaded():
     messages.clear_all_messages()
     try:

rust/messages.py

@@ -20,9 +20,11 @@
 # Value is a dictionary: {
 #     'paths': {path: [MessageBatch, ...]},
 #     'batch_index': (path_idx, message_idx),
+#     'hidden': bool
 # }
 # `paths` is an OrderedDict to handle next/prev message.
 # `path` is the absolute path to the file.
+# `hidden` indicates that all messages have been dismissed.
 WINDOW_MESSAGES = {}
 
 
@@ -157,11 +159,20 @@ def __repr__(self):
         return ''.join(result)
 
 
-def clear_messages(window):
-    """Remove all messages for the given window."""
-    for path, batches in WINDOW_MESSAGES.pop(window.id(), {})\
-                                        .get('paths', {})\
-                                        .items():
+def clear_messages(window, soft=False):
+    """Remove all messages for the given window.
+
+    :param soft: If True, the messages are kept in memory and can be
+        resurrected with various commands (such as list messages, or
+        next/prev).
+    """
+    if soft:
+        winfo = WINDOW_MESSAGES.get(window.id(), {})
+        winfo['hidden'] = True
+    else:
+        winfo = WINDOW_MESSAGES.pop(window.id(), {})
+
+    for path, batches in winfo.get('paths', {}).items():
         view = window.find_open_file(path)
         if view:
             for batch in batches:
@@ -241,8 +252,13 @@ def _draw_region_highlights(view, batch):
 
 def message_popup(view, point, hover_zone):
     """Displays a popup if there is a message at the given point."""
-    paths = WINDOW_MESSAGES.get(view.window().id(), {}).get('paths', {})
-    batches = paths.get(view.file_name(), [])
+    try:
+        winfo = WINDOW_MESSAGES[view.window().id()]
+    except KeyError:
+        return
+    if winfo['hidden']:
+        return
+    batches = winfo['paths'].get(view.file_name(), [])
 
     if hover_zone == sublime.HOVER_GUTTER:
         # Collect all messages on this line.
@@ -285,7 +301,7 @@ def filter_point(batch):
 
 def _click_handler(view, url, hide_popup=False):
     if url == 'hide':
-        clear_messages(view.window())
+        clear_messages(view.window(), soft=True)
         if hide_popup:
             view.hide_popup()
     elif url.startswith('file:///'):
@@ -426,6 +442,8 @@ def _show_message(window, current_idx, transient=False, force_open=False):
         window_info = WINDOW_MESSAGES[window.id()]
     except KeyError:
         return
+    if window_info['hidden']:
+        redraw_all_open_views(window)
     paths = window_info['paths']
     path, batches = _ith_iter_item(paths.items(), current_idx[0])
     batch = batches[current_idx[1]]
@@ -482,36 +500,40 @@ def _scroll_build_panel(window, message):
         from . import opanel
         view = window.find_output_panel(opanel.PANEL_NAME)
         if view:
-            view.sel().clear()
-            region = message.output_panel_region
-            view.sel().add(region)
-            view.show(region)
-            # Force panel to update.
-            # TODO: See note about workaround below.
-            view.add_regions('bug', [region], 'bug', 'dot', sublime.HIDDEN)
-            view.erase_regions('bug')
+            r = message.output_panel_region
+            view.run_command('rust_scroll_to_region', {'region': (r.a, r.b)})
 
 
 def _scroll_to_message(view, message, transient):
     """Scroll view to the message."""
     if not transient:
         view.window().focus_view(view)
     r = message.sublime_region(view)
-    view.sel().clear()
-    view.sel().add(r.a)
-    view.show_at_center(r)
-    # TODO: Fix this to use a TextCommand to properly handle undo.
-    # See https://github.com/SublimeTextIssues/Core/issues/485
-    view.add_regions('bug', [r], 'bug', 'dot', sublime.HIDDEN)
-    view.erase_regions('bug')
+    view.run_command('rust_scroll_to_region', {'region': (r.a, r.a)})
+
+
+def redraw_all_open_views(window):
+    """Re-display phantoms/regions after being hidden."""
+    try:
+        winfo = WINDOW_MESSAGES[window.id()]
+    except KeyError:
+        return
+    winfo['hidden'] = False
+    for path, batches in winfo['paths'].items():
+        view = window.find_open_file(path)
+        if view:
+            show_messages_for_view(view)
 
 
 def show_messages_for_view(view):
     """Adds all phantoms and region outlines for a view."""
-    window = view.window()
-    batches = WINDOW_MESSAGES.get(window.id(), {})\
-                             .get('paths', {})\
-                             .get(view.file_name(), [])
+    try:
+        winfo = WINDOW_MESSAGES[view.window().id()]
+    except KeyError:
+        return
+    if winfo['hidden']:
+        return
+    batches = winfo['paths'].get(view.file_name(), [])
     for batch in batches:
         _show_phantom(view, batch)
         _draw_region_highlights(view, batch)
@@ -629,6 +651,8 @@ def list_messages(window):
         # XXX: Or dialog?
         window.show_quick_panel(["No messages available"], None)
         return
+    if win_info['hidden']:
+        redraw_all_open_views(window)
     panel_items = []
     jump_to = []
     for path_idx, (path, batches) in enumerate(win_info['paths'].items()):
@@ -1025,7 +1049,8 @@ def _save_batches(window, batches, msg_cb):
         path_to_batches = collections.OrderedDict()
         WINDOW_MESSAGES[wid] = {
             'paths': path_to_batches,
-            'batch_index': (-1, -1)
+            'batch_index': (-1, -1),
+            'hidden': False,
         }
 
     for batch in batches: