Merge pull request #8 from SublimeText/feature/dirty-tab-indicator

Add dirty tab indicator

Author: FichteFoll

plugin/_compat.py

@@ -17,11 +17,23 @@ def set(self, key, value):
         def erase(self, key):
             self.pop(key, None)
 
+    class _QuickPanelItem:
+        __slots__ = ["trigger", "details", "annotation", "kind"]
+
+        def __init__(self, trigger, details="", annotation="", kind=(0, "", "")):
+            self.trigger = trigger
+            self.details = details
+            self.annotation = annotation
+            self.kind = kind
+
     class _SublimeModule(SimpleNamespace):
         OP_EQUAL = 0
         OP_NOT_EQUAL = 1
         KEEP_OPEN_ON_FOCUS_LOST = 0
         MONOSPACE_FONT = 0
+        KIND_ID_COLOR_ORANGISH = 10
+        KIND_AMBIGUOUS = (0, "", "")
+        QuickPanelItem = _QuickPanelItem
 
         def set_timeout(self, callback, timeout=0):
             callback()

plugin/constants.py

@@ -1 +1,5 @@
+from ._compat import sublime
+
 TAB_HISTORY_LIMIT = 20
+
+KIND_MODIFIED = (sublime.KIND_ID_COLOR_ORANGISH, "●", "Modified")

plugin/mru.py

@@ -5,14 +5,15 @@
 
 from .captions import caption_for_sheet_identities
 from .constants import TAB_HISTORY_LIMIT
-from .sheets import SheetIdentity, sheet_identity
+from .sheets import SheetIdentity, identities_have_dirty_sheet, sheet_identity
 from .state import GroupSelectionState, SheetSelectionHistory
 
 
 @dataclass
 class Entry:
     selection: GroupSelectionState
     caption: list[str]
+    dirty: bool = False
 
 
 def collect_entries(window, history: SheetSelectionHistory) -> list[Entry]:
@@ -23,10 +24,12 @@ def collect_entries(window, history: SheetSelectionHistory) -> list[Entry]:
     group_state_stack = history["groups"].get(str(active_group))
     if group_state_stack:
         for group_state in group_state_stack:
+            identities = group_state["selected_sheets"]
             entries.append(
                 Entry(
                     selection=group_state,
-                    caption=caption_for_sheet_identities(group_state["selected_sheets"], window),
+                    caption=caption_for_sheet_identities(identities, window),
+                    dirty=identities_have_dirty_sheet(identities, window, active_group),
                 )
             )
             seen_identities.update(_selection_identity_keys(group_state))
@@ -38,20 +41,21 @@ def collect_entries(window, history: SheetSelectionHistory) -> list[Entry]:
         if identity in seen_identities:
             continue
 
-        entries.append(_entry_for_sheet(sheet, window))
+        entries.append(_entry_for_sheet(sheet, window, active_group))
         seen_identities.add(identity)
 
     return entries
 
 
-def _entry_for_sheet(sheet, window) -> Entry:
+def _entry_for_sheet(sheet, window, group: int) -> Entry:
     identity = sheet_identity(sheet, window)
     return Entry(
         selection={
             "active_sheet_index": 0,
             "selected_sheets": [identity],
         },
         caption=caption_for_sheet_identities([identity], window),
+        dirty=identities_have_dirty_sheet([identity], window, group),
     )
 
 

plugin/session.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from ._compat import sublime
+from .constants import KIND_MODIFIED
 from .ctrl_release import CtrlReleasePoller
 from .sheets import apply_group_selection
 from .state import TabStackWindowState
@@ -26,7 +27,14 @@ def show_panel(window, state) -> None:
     if not state.session_active or not state.session_entries:
         return
 
-    items = [entry.caption for entry in state.session_entries]
+    items = [
+        sublime.QuickPanelItem(
+            trigger=entry.caption[0],
+            details=entry.caption[1],
+            kind=KIND_MODIFIED if entry.dirty else sublime.KIND_AMBIGUOUS,
+        )
+        for entry in state.session_entries
+    ]
 
     def on_select(index: int) -> None:
         if index < 0:

plugin/sheets.py

@@ -79,6 +79,19 @@ def sheet_name(sheet) -> Optional[str]:
     return get_name() if get_name else None
 
 
+def sheet_is_dirty(sheet) -> bool:
+    view = sheet.view()
+    return view is not None and view.is_dirty()
+
+
+def identities_have_dirty_sheet(identities: list[SheetIdentity], window, group: int) -> bool:
+    return any(
+        (sheet := find_sheet_by_identity_and_group(window, identity, group)) is not None
+        and sheet_is_dirty(sheet)
+        for identity in identities
+    )
+
+
 def find_live_sheets(window, identities: list[SheetIdentity], group: int) -> list[object]:
     return [
         live_sheet